Repository navigation
docs(platform): document login --json and the cli's json error codes - #46
Merged
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
The command line page now covers what scripts and agents get from
--jsonin the newer CLI releases. It addstelemetry login --json, which prints the sign-in link and returns without opening a browser or waiting, andtelemetry logout --json. A new Errors section gives the one-line JSON error format, whatcode,hint, andretryablemean, and the table of error codes.Each statement says which CLI version it applies to. The JSON error format shipped in 0.1.1.
login --json,logout --json, and the codesinvalid_cursor,access_denied,trace_not_found,span_not_found, andserver_errorcome in 0.1.2, from telemetry-dev/telemetry#131 and telemetry-dev/telemetry#134.Merge after
@telemetry-dev/cli0.1.2 is on npm with both of those changes. If #134 ships in a later release, the version mentions for those codes need to change to that release.