Skip to content

chore(telemetry): log when getting public cloud info or resolving srv fails #6672

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 5 commits into from
Feb 4, 2025
Merged

chore(telemetry): log when getting public cloud info or resolving srv fails #6672

Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
0d7df85
log when getting public cloud info fails
lerouxb Jan 31, 2025
88c0b17
add debug too
lerouxb Jan 31, 2025
884daa9
also add the host to the error logging
lerouxb Jan 31, 2025
db5a02d
Update packages/compass/src/app/utils/telemetry.ts
lerouxb Jan 31, 2025
004fce9
also log when resolveMongodbSrv fails
lerouxb Feb 4, 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
25 changes: 24 additions & 1 deletion packages/compass/src/app/utils/telemetry.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,8 @@ import { getCloudInfo } from 'mongodb-cloud-info';
import ConnectionString from 'mongodb-connection-string-url';
import resolveMongodbSrv from 'resolve-mongodb-srv';
import type { KMSProviders, MongoClientOptions } from 'mongodb';
import { createLogger } from '@mongodb-js/compass-logging';
const { debug, log, mongoLogId } = createLogger('COMPASS-TELEMETRY');

type HostInformation = {
is_localhost: boolean;
Expand Down Expand Up @@ -38,6 +40,14 @@ async function getPublicCloudInfo(host: string): Promise<{
public_cloud_name,
};
} catch (err) {
debug(`getCloudInfo failed for "${host}": ${(err as Error).message}`);

log.warn(
mongoLogId(1_001_000_339),
'getPublicCloudInfo',
'Failed to look up host cloud information for telemetry',
{ host, error: (err as Error).message }
);
return {};
}
}
Expand Down Expand Up @@ -148,7 +158,20 @@ async function getHostnameForConnection(
);
if (connectionStringData.isSRV) {
const uri = await resolveMongodbSrv(connectionStringData.toString()).catch(
() => {
(err: unknown) => {
debug(
`resolveMongodbSrv failed for "${connectionStringData.hosts.join(
','
)}": ${(err as Error).message}`
);

log.warn(
mongoLogId(1_001_000_340),
'resolveMongodbSrv',
'Failed to resolve mongodb srv for telemetry',
{ hosts: connectionStringData.hosts, error: (err as Error).message }
);

return null;
}
);
Expand Down