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

The db healthy check should be utilising the data property to store key information #2205

Open
thompson-tomo opened this issue Apr 28, 2024 · 1 comment · May be fixed by #2228
Open

The db healthy check should be utilising the data property to store key information #2205

thompson-tomo opened this issue Apr 28, 2024 · 1 comment · May be fixed by #2228

Comments

@thompson-tomo
Copy link

thompson-tomo commented Apr 28, 2024

What would you like to be added:
In HealthReportEntry, I would like the data field to be populated even in a healthy case.
The Data field should be populated with the health check type & some additional meta data obtained from the options. At the same time other key OTEL information about db should be populated

When comparisons are occurring a threshold, both the current value and threshold should be returned.

the keys in the data properties should be following open telemetry semantic conventions with the key areas being:

  • event.name = database.healthcheck where name is constructed using {{eventCategory}}.{{eventType}}
  • healthcheck.name = the name of the healthcheck
  • healthcheck.task = online/ready
  • db.system = the name of the db provider as already defined in the semantic conventions

where possible we should also be setting

  • db.namespace
  • db.collection.name
  • db.query.text
  • server.address
  • server.port
  • client.address
  • network.protocol.name
  • network.protocol.version
  • network.transport

Why is this needed:
Allows for more contextual information about health checks to be recorded/captured

Additional Information
Request for semantic conventions has been submitted via: open-telemetry/semantic-conventions#1106

@thompson-tomo thompson-tomo changed the title A healthy check should be returning more information A healthy check should be utilising the data property Jun 1, 2024
@thompson-tomo thompson-tomo changed the title A healthy check should be utilising the data property The db healthy check should be utilising the data property to store key information Jun 1, 2024
thompson-tomo added a commit to thompson-tomo/AspNetCore.Diagnostics.HealthChecks that referenced this issue Jun 1, 2024
thompson-tomo added a commit to thompson-tomo/AspNetCore.Diagnostics.HealthChecks that referenced this issue Jun 1, 2024
@thompson-tomo thompson-tomo linked a pull request Jun 1, 2024 that will close this issue
6 tasks
@adamsitnik
Copy link
Collaborator

cc @DamianEdwards @eerhardt

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants