Skip to content

Add more Cirrus error logging info #5483

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 7 commits into from
Jan 14, 2025
Merged

Add more Cirrus error logging info #5483

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
6e67c86
Add cirrus logging errors
codemist Jan 10, 2025
39a3a29
remove middleware logging
codemist Jan 10, 2025
8c23f7b
revert code change in middleware
codemist Jan 13, 2025
cdb32cf
remove logging userId
codemist Jan 13, 2025
1412e7c
remove logging experimentId
codemist Jan 13, 2025
173744c
Merge branch 'main' into cirrus-logs
codemist Jan 14, 2025
43e82de
Merge branch 'main' into cirrus-logs
codemist Jan 14, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 9 additions & 0 deletions src/app/functions/server/getExperimentationId.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,12 @@ export function getExperimentationId(
// If the user is logged in, use the Subscriber ID.
const namespace = process.env.NIMBUS_UUID_NAMESPACE;
if (!namespace) {
logger.error(
"NIMBUS_UUID_NAMESPACE environment variable is missing. Cannot generate experimentationId.",
{
accountId,
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Let's avoid logging the accountId, any problem here is unlikely to be related to the user (more likely the variable we need is not set)

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fixed in cdb32cf

},
);
throw new Error(
"NIMBUS_UUID_NAMESPACE not set, cannot create experimentationId",
);
Expand All @@ -47,6 +53,9 @@ export function getExperimentationId(
);
return "guest-no-experimentation-id-set-by-monitor-middleware";
}
logger.info("Using experimentationId from header for guest user", {
experimentationId,
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Likewise here, let's just lot that this is being set without logging the ID.

});
return experimentationId as ExperimentationId;
}
}
21 changes: 20 additions & 1 deletion src/app/functions/server/getExperiments.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,6 +50,12 @@ export async function getExperiments(params: {
serverUrl.searchParams.set("nimbus_preview", "true");
}

logger.info("Sending request to Cirrus", {
serverUrl: serverUrl.toString(),
previewMode: params.previewMode,
client_id: params.experimentationId,
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Let's not log the experimentationId, the other params are fine.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fixed in 1412e7c

});

const response = await fetch(serverUrl, {
headers: {
"Content-Type": "application/json",
Expand All @@ -65,6 +71,14 @@ export async function getExperiments(params: {
}),
});

if (!response.ok) {
logger.error("Cirrus request failed", {
status: response.status,
url: serverUrl.toString(),
});
throw new Error(`Cirrus request failed: ${response.statusText}`);
}

const json = await response.json();

let experimentData;
Expand All @@ -76,7 +90,12 @@ export async function getExperiments(params: {

return (experimentData as ExperimentData) ?? defaultExperimentData;
} catch (ex) {
logger.error("Could not connect to Cirrus", { serverUrl, ex });
logger.error("Could not connect to Cirrus", {
serverUrl,
ex,
flags,
params,
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think in this case it's OK (since we could be sending invalid params)

});
captureException(ex);
return defaultExperimentData;
}
Expand Down
8 changes: 0 additions & 8 deletions src/middleware.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,14 +43,6 @@ export function middleware(request: NextRequest) {
},
});

if (!existingExperimentationId) {
response.cookies.set({
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why remove this?

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think the point of setting the cookie is for users that are not authenticated, so there's no way to keep track of which experiments or roll-outs they are enrolled in otherwise.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

My bad, I was just supposed to remove the logger line in this file. Good catch!

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fixed in 8c23f7b

name: "experimentationId",
value: experimentationId,
path: "/",
});
}

return response;
}

Expand Down
Loading