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

Synchronize the reasons in CRs status messages for different signals #1023

Closed
a-thaler opened this issue Apr 29, 2024 · 1 comment · Fixed by #1099 or #1038
Closed

Synchronize the reasons in CRs status messages for different signals #1023

a-thaler opened this issue Apr 29, 2024 · 1 comment · Fixed by #1099 or #1038
Assignees
Labels
area/manager Manager or module changes kind/feature Categorizes issue or PR as related to a new feature.
Milestone

Comments

@a-thaler
Copy link
Collaborator

a-thaler commented Apr 29, 2024

Description
Currently we show following status messages at telemetry CR. We should synchronize the Reasons so that they all have similar naming patterns.

Type Reason
MetricComponentHealthy MetricPipelineReferencedSecretMissing
MetricComponentHealthy MetricGatewayDeploymentNotReady.
TraceComponentHealthy TracePipelineReferencedSecretMissing.
TraceComponentHealthy TraceGatewayDeploymentNotReady
LogComponentHealthy TLSCertificateExpired

See this for a full list of reasons

Criterias

  • All reasons in the module CRD are using a consistent naming pattern
  • CRD documentation is updated according to the changes
  • Improve and review the condition messages, have it user centric and actionable. If there is more to explain, add it to the API documentation and link it.
@a-thaler a-thaler added kind/bug Categorizes issue or PR as related to a bug. area/manager Manager or module changes labels Apr 29, 2024
@TeodorSAP TeodorSAP self-assigned this May 2, 2024
@NHingerl
Copy link
Contributor

NHingerl commented May 16, 2024

Logs: No troubleshooting guides existing at all.

  • Condition BufferFillingUp: We might need a logs troubleshooting guide for buffer overflow, similar to the troubleshooting guides for Traces and Metrics.
  • Condition NoLogsDelivered: Again, probably a new troubleshooting guide required.
  • Condition SomeDataDropped and AllDataDropped: Probably also a troubleshooting guide needed.

Traces + Metrics: Some troubleshooting guides exist to which we could link ("no xy arriving in the backend"), some might have to be created.

@TeodorSAP TeodorSAP added kind/feature Categorizes issue or PR as related to a new feature. and removed kind/bug Categorizes issue or PR as related to a bug. labels May 16, 2024
@TeodorSAP TeodorSAP changed the title Synchronize the reasons in TelemetryCR status messages for different signals Synchronize the reasons in CRs status messages for different signals May 21, 2024
@TeodorSAP TeodorSAP linked a pull request May 21, 2024 that will close this issue
8 tasks
@a-thaler a-thaler added this to the 1.17.0 milestone Jun 3, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/manager Manager or module changes kind/feature Categorizes issue or PR as related to a new feature.
Projects
None yet
3 participants