Skip to content
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

telemetry(lsp): standardize setup metric and types #961

Merged
merged 14 commits into from
Jan 23, 2025
Merged

telemetry(lsp): standardize setup metric and types #961

Changes from 2 commits
Commits
Show all changes
14 commits
Select commit Hold shift + click to select a range
46e9a7c
port over definition of types and metrics
Hweinstock Jan 21, 2025
76711ac
fix sorting issues
Hweinstock Jan 21, 2025
97ad716
make metric more verbose
Hweinstock Jan 22, 2025
b9a6e10
switch to version
Hweinstock Jan 22, 2025
bed88b8
reorder metric types
Hweinstock Jan 22, 2025
911286f
fix linting problem
Hweinstock Jan 22, 2025
6cc5f81
remove required: true from relevant metadata
Hweinstock Jan 22, 2025
7ae5a99
Update telemetry/definitions/commonDefinitions.json
Hweinstock Jan 22, 2025
f1b3077
add passive tag
Hweinstock Jan 22, 2025
948a643
change manifestVersion to manifestSchemaVersion
Hweinstock Jan 22, 2025
6deaac8
change version -> languageServerVersion
Hweinstock Jan 23, 2025
23f1184
fix ordering of metadata
Hweinstock Jan 23, 2025
a88e6d4
remove fallback option for manifest
Hweinstock Jan 23, 2025
2b39dbf
add result metadata field
Hweinstock Jan 23, 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
35 changes: 35 additions & 0 deletions telemetry/definitions/commonDefinitions.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1413,6 +1413,18 @@
"type": "string",
"description": "Language used for the project."
},
{
"name": "languageServerResourceLocation",
justinmk3 marked this conversation as resolved.
Show resolved Hide resolved
"type": "string",
"allowedValues": ["cache", "remote", "fallback", "override", "unknown"],
"description": "The location of the LSP resource"
},
{
"name": "languageServerSetupStage",
"type": "string",
"allowedValues": ["getManifest", "getServer", "validate", "launch", "final"],
"description": "The stage of the LSP setup process"
},
{
"name": "loadFileTime",
"type": "int",
Expand All @@ -1423,6 +1435,11 @@
"type": "string",
"description": "User locale. Examples: en-US, en-GB, etc."
},
{
"name": "manifestVersion",
"type": "string",
"description": "The version of the manifest file"
},
{
"name": "metricId",
"type": "string",
Expand Down Expand Up @@ -5971,6 +5988,24 @@
}
]
},
{
"name": "languageServer_setup",
"description": "LSP setup event",
Hweinstock marked this conversation as resolved.
Show resolved Hide resolved
Hweinstock marked this conversation as resolved.
Show resolved Hide resolved
"metadata": [
Copy link
Contributor

Choose a reason for hiding this comment

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

This is a passive event because users do not take an actual action for this to occur, please indicate the same. In addition fields of duration and result is missing from this shape

Copy link
Contributor Author

@Hweinstock Hweinstock Jan 22, 2025 •
edited
Loading

Choose a reason for hiding this comment

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

I thought these were global arguments so they would be automatically populated?

aws-toolkit-common/telemetry/telemetryformat.md

Line 49 in ab46602

### Global Arguments
Is it still required to add them to the shape as well?

Also found in the VS generator I think? https://github.com/aws/aws-toolkit-common/blob/ab466029f241193ab93a8abb3a5ca8dde5f56c94/telemetry/csharp/AwsToolkit.Telemetry.Events/Core/BaseTelemetryEvent.cs#L90C24-L90C32

Copy link
Contributor

Choose a reason for hiding this comment

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

Duration is implicit with the C# generator, but we don't have support for result, so this field needs to be added to the metadata.

Copy link
Contributor

Choose a reason for hiding this comment

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

but we don't have support for result, so this field needs to be added to the metadata.

Can that be prioritized? Adding result explicitly to every metric confuses the messaging for partner teams.

{
"type": "languageServerResourceLocation",
"required": false
},
{
"type": "languageServerSetupStage",
"required": true
},
{
"type": "manifestVersion",
Hweinstock marked this conversation as resolved.
Show resolved Hide resolved
"required": false
}
]
},
{
"name": "rds_createConnectionConfiguration",
"description": "Called when creating a new database connection configuration to for a RDS database. In Datagrip we do not get this infromation if it is created directly, so this is only counts actions.",
Expand Down
Loading