Skip to content

feat: upgrade observe-agent health check extension to health check v2#307

Open
obs-gh-ruoyuchen wants to merge 2 commits into
mainfrom
ruoyu/health-check-v2
Open

feat: upgrade observe-agent health check extension to health check v2#307
obs-gh-ruoyuchen wants to merge 2 commits into
mainfrom
ruoyu/health-check-v2

Conversation

@obs-gh-ruoyuchen
Copy link
Copy Markdown
Collaborator

Description

Upgrade observe-agent health check extension to health check v2

Copy link
Copy Markdown

@orca-security-us orca-security-us Bot left a comment

Choose a reason for hiding this comment

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

Orca Security Scan Summary

Status Check Issues by priority
Passed Passed Infrastructure as Code high 0   medium 0   low 0   info 0 View in Orca
Passed Passed SAST high 0   medium 0   low 0   info 0 View in Orca
Passed Passed Secrets high 0   medium 0   low 0   info 0 View in Orca
Passed Passed Vulnerabilities high 0   medium 0   low 0   info 0 View in Orca

Copy link
Copy Markdown
Collaborator

@obs-gh-mattcotter obs-gh-mattcotter left a comment

Choose a reason for hiding this comment

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

Looks great! A few comments on top of my two inline:

  1. Can you update the table in the README to reflect the new extension?
  2. Can you enable this test locally and make sure it passes: https://github.com/observeinc/observe-agent/blob/main/internal/commands/config/config_test.go#L102

health_check:
endpoint: {{ .HealthCheck.Endpoint }}
path: {{ .HealthCheck.Path }}
healthcheckv2:
Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

This looks great! Can you add a new bool config option in the HealthCheck config to toggle between the health_check extension and the healthcheckv2? See: https://github.com/observeinc/observe-agent/blob/main/internal/config/configschema.go#L52

I think we could call it use_v2 even though it wonn't math the OTel use_v2. If we default it to false, then we can experiment with the new extension without changing any user flows.

Comment thread observecol/go.mod
github.com/open-telemetry/opentelemetry-collector-contrib/exporter/prometheusremotewriteexporter v0.144.0
github.com/open-telemetry/opentelemetry-collector-contrib/exporter/syslogexporter v0.144.0
github.com/open-telemetry/opentelemetry-collector-contrib/extension/cgroupruntimeextension v0.144.0
github.com/open-telemetry/opentelemetry-collector-contrib/extension/healthcheckextension v0.144.0
Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Let's leave the existing extension so we can toggle between the two. Even if we were doing a full replace with our bundled config, we would still want to support user overrides that rely on health_check existing.

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 this pull request may close these issues.

2 participants