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.

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

[Error Handling] - Enhance trace error handling messaging #2389

Closed
Tracked by #2331
kdhamric opened this issue Apr 14, 2023 · 1 comment · Fixed by #2398
Closed
Tracked by #2331

[Error Handling] - Enhance trace error handling messaging #2389

kdhamric opened this issue Apr 14, 2023 · 1 comment · Fixed by #2398
Assignees
Labels
enhancement New feature or request triage requires triage

Comments

@kdhamric
Copy link
Collaborator

kdhamric commented Apr 14, 2023

We should enhance the information shown on the Trace error handling screen for a couple of reasons:
it will help the end user
If they take a screenshot of the error and send it to us, we will have more info shown in the screenshot to assist the user.

AC1:
Make sure the choice of data source and config of it is at least summarized.

AC2: When a trace is not found, including the parent trace id in the final error message.

Data store types and fields

jaeger:
          $ref: "#/components/schemas/GRPCClientSettings"
        tempo:
          $ref: "#/components/schemas/BaseClient"
        openSearch:
          $ref: "#/components/schemas/ElasticSearch"
        elasticApm:
          $ref: "#/components/schemas/ElasticSearch"
        signalFx:
          $ref: "#/components/schemas/SignalFX"
        awsxray:
          $ref: "#/components/schemas/AwsXRay"
BaseClient:
      type: object
      properties:
        type:
          $ref: "#/components/schemas/SupportedClients"
        http:
          $ref: "#/components/schemas/HTTPClientSettings"
        grpc:
          $ref: "#/components/schemas/GRPCClientSettings"
    ElasticSearch:
      type: object
      properties:
        addresses:
          type: array
          items:
            type: string
        username:
          type: string
        password:
          type: string
        index:
          type: string
        certificate:
          type: string
        insecureSkipVerify:
          type: boolean
    SignalFX:
      type: object
      properties:
        realm:
          type: string
        token:
          type: string
    AwsXRay:
      type: object
      properties:
        region:
          type: string
        accessKeyId:
          type: string
        secretAccessKey:
          type: string
        sessionToken:
          type: string
        useDefaultAuth:
          type: boolean
    HTTPClientSettings:
      type: object
      properties:
        url:
          type: string
        headers:
          type: object
          additionalProperties:
            type: string
        tls:
          $ref: "#/components/schemas/TLS"
        auth:
          $ref: "./http.yaml#/components/schemas/HTTPAuth"
    GRPCClientSettings:
      type: object
      properties:
        endpoint:
          type: string
        readBufferSize:
          type: number
        writeBufferSize:
          type: number
        waitForReady:
          type: boolean
        headers:
          type: object
          additionalProperties:
            type: string
        balancerName:
          type: string
        compression:
          type: string
          enum:
            - "gzip"
            - "zlib"
            - "deflate"
            - "snappy"
            - "zstd"
            - "none"
            - ""
        tls:
          $ref: "#/components/schemas/TLS"
        auth:
          $ref: "./http.yaml#/components/schemas/HTTPAuth"
@kdhamric kdhamric added enhancement New feature or request triage requires triage labels Apr 14, 2023
@jorgeepc jorgeepc changed the title Enhance trace error handling messaging [Error Handling] - Enhance trace error handling messaging Apr 14, 2023
@olha23
Copy link

olha23 commented Apr 17, 2023

@kdhamric can you please check the mockups:

for AC2: When a trace is not found, including the parent trace id in the final error message -
https://www.figma.com/file/LBN4SKVPq3ykegrPKbHT2Y/0.8-0.9-Release-Tracetest?node-id=2377%3A34080&t=ofaUBNQkISdycBvY-1

for AC1: "Make sure the choice of data source and config of it is at least summarized."
i am not sure what do you mean here, so i just add action link in error message for user and clicking it takes user to the config screen with ability to change setting - https://www.figma.com/file/LBN4SKVPq3ykegrPKbHT2Y/0.8-0.9-Release-Tracetest?node-id=2377%3A33830&t=ofaUBNQkISdycBvY-1

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request triage requires triage
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants