Skip to content

Commit

Permalink
Introduce health check extension based on component status reporting
Browse files Browse the repository at this point in the history
  • Loading branch information
mwear committed Jan 21, 2024
1 parent a9bce75 commit 6587834
Show file tree
Hide file tree
Showing 37 changed files with 4,334 additions and 0 deletions.
27 changes: 27 additions & 0 deletions .chloggen/healthcheck-v2.yaml
@@ -0,0 +1,27 @@
# Use this changelog template to create an entry for release notes.

# One of 'breaking', 'deprecation', 'new_component', 'enhancement', 'bug_fix'
change_type: 'new_component'

# The name of the component, or a single word describing the area of concern, (e.g. filelogreceiver)
component: healthcheckextensionv2

# A brief description of the change. Surround your text with quotes ("") if it needs to start with a backtick (`).
note: Health Check Extension V2 is meant to be a replacement for the current Health Check Extension. It is based off of component status reporting and provides HTTP and gRPC services health check services.

# Mandatory: One or more tracking issues related to the change. You can use the PR number here if no issue exists.
issues: [26661]

# (Optional) One or more lines of additional information to render under the primary note.
# These lines will be padded with 2 spaces and then inserted directly into the document.
# Use pipe (|) for multiline entries.
subtext:

# If your change doesn't affect end users or the exported elements of any package,
# you should instead start your pull request title with [chore] or use the "Skip Changelog" label.
# Optional: The change log or logs in which this entry should be included.
# e.g. '[user]' or '[user, api]'
# Include 'user' if the change is relevant to end users.
# Include 'api' if there is a change to a library API.
# Default: '[user]'
change_logs: []
1 change: 1 addition & 0 deletions .github/CODEOWNERS
Validating CODEOWNERS rules …
Expand Up @@ -93,6 +93,7 @@ extension/encoding/textencodingextension/ @open-telemetry/collect
extension/encoding/zipkinencodingextension/ @open-telemetry/collector-contrib-approvers @MovieStoreGuy @dao-jun
extension/headerssetterextension/ @open-telemetry/collector-contrib-approvers @jpkrohling
extension/healthcheckextension/ @open-telemetry/collector-contrib-approvers @jpkrohling
extension/healthcheckextensionv2/ @open-telemetry/collector-contrib-approvers @mwear
extension/httpforwarder/ @open-telemetry/collector-contrib-approvers @atoulme @rmfitzpatrick
extension/jaegerremotesampling/ @open-telemetry/collector-contrib-approvers @yurishkuro @frzifus
extension/oauth2clientauthextension/ @open-telemetry/collector-contrib-approvers @pavankrish123 @jpkrohling
Expand Down
1 change: 1 addition & 0 deletions .github/ISSUE_TEMPLATE/bug_report.yaml
Expand Up @@ -92,6 +92,7 @@ body:
- extension/encoding/zipkinencoding
- extension/headerssetter
- extension/healthcheck
- extension/healthcheckextensionv2
- extension/httpforwarder
- extension/jaegerremotesampling
- extension/oauth2clientauth
Expand Down
1 change: 1 addition & 0 deletions .github/ISSUE_TEMPLATE/feature_request.yaml
Expand Up @@ -86,6 +86,7 @@ body:
- extension/encoding/zipkinencoding
- extension/headerssetter
- extension/healthcheck
- extension/healthcheckextensionv2
- extension/httpforwarder
- extension/jaegerremotesampling
- extension/oauth2clientauth
Expand Down
1 change: 1 addition & 0 deletions .github/ISSUE_TEMPLATE/other.yaml
Expand Up @@ -86,6 +86,7 @@ body:
- extension/encoding/zipkinencoding
- extension/headerssetter
- extension/healthcheck
- extension/healthcheckextensionv2
- extension/httpforwarder
- extension/jaegerremotesampling
- extension/oauth2clientauth
Expand Down
2 changes: 2 additions & 0 deletions cmd/otelcontribcol/builder-config.yaml
Expand Up @@ -14,6 +14,7 @@ extensions:
- gomod: github.com/open-telemetry/opentelemetry-collector-contrib/extension/bearertokenauthextension v0.92.0
- gomod: github.com/open-telemetry/opentelemetry-collector-contrib/extension/headerssetterextension v0.92.0
- gomod: github.com/open-telemetry/opentelemetry-collector-contrib/extension/healthcheckextension v0.92.0
- gomod: github.com/open-telemetry/opentelemetry-collector-contrib/extension/healthcheckextensionv2 v0.92.0
- gomod: github.com/open-telemetry/opentelemetry-collector-contrib/extension/httpforwarder v0.92.0
- gomod: github.com/open-telemetry/opentelemetry-collector-contrib/extension/jaegerremotesampling v0.92.0
- gomod: github.com/open-telemetry/opentelemetry-collector-contrib/extension/oauth2clientauthextension v0.92.0
Expand Down Expand Up @@ -266,6 +267,7 @@ replaces:
- github.com/open-telemetry/opentelemetry-collector-contrib/receiver/couchdbreceiver => ../../receiver/couchdbreceiver
- github.com/open-telemetry/opentelemetry-collector-contrib/processor/resourcedetectionprocessor => ../../processor/resourcedetectionprocessor
- github.com/open-telemetry/opentelemetry-collector-contrib/extension/healthcheckextension => ../../extension/healthcheckextension
- github.com/open-telemetry/opentelemetry-collector-contrib/extension/healthcheckextensionv2 => ../../extension/healthcheckextensionv2
- github.com/open-telemetry/opentelemetry-collector-contrib/extension/headerssetterextension => ../../extension/headerssetterextension
- github.com/open-telemetry/opentelemetry-collector-contrib/exporter/googlemanagedprometheusexporter => ../../exporter/googlemanagedprometheusexporter
- github.com/open-telemetry/opentelemetry-collector-contrib/receiver/aerospikereceiver => ../../receiver/aerospikereceiver
Expand Down
2 changes: 2 additions & 0 deletions cmd/otelcontribcol/components.go

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

9 changes: 9 additions & 0 deletions cmd/otelcontribcol/extensions_test.go
Expand Up @@ -25,6 +25,7 @@ import (
"github.com/open-telemetry/opentelemetry-collector-contrib/extension/bearertokenauthextension"
"github.com/open-telemetry/opentelemetry-collector-contrib/extension/headerssetterextension"
"github.com/open-telemetry/opentelemetry-collector-contrib/extension/healthcheckextension"
healthcheckextensionv2 "github.com/open-telemetry/opentelemetry-collector-contrib/extension/healthcheckextensionv2"
"github.com/open-telemetry/opentelemetry-collector-contrib/extension/httpforwarder"
"github.com/open-telemetry/opentelemetry-collector-contrib/extension/jaegerremotesampling"
"github.com/open-telemetry/opentelemetry-collector-contrib/extension/oauth2clientauthextension"
Expand Down Expand Up @@ -59,6 +60,14 @@ func TestDefaultExtensions(t *testing.T) {
return cfg
},
},
{
extension: "healthcheckv2",
getConfigFn: func() component.Config {
cfg := extFactories["healthcheckv2"].CreateDefaultConfig().(*healthcheckextensionv2.Config)
cfg.HTTPSettings.Endpoint = endpoint
return cfg
},
},
{
extension: "pprof",
getConfigFn: func() component.Config {
Expand Down
3 changes: 3 additions & 0 deletions cmd/otelcontribcol/go.mod
Expand Up @@ -67,6 +67,7 @@ require (
github.com/open-telemetry/opentelemetry-collector-contrib/extension/encoding/zipkinencodingextension v0.92.0
github.com/open-telemetry/opentelemetry-collector-contrib/extension/headerssetterextension v0.92.0
github.com/open-telemetry/opentelemetry-collector-contrib/extension/healthcheckextension v0.92.0
github.com/open-telemetry/opentelemetry-collector-contrib/extension/healthcheckextensionv2 v0.92.0
github.com/open-telemetry/opentelemetry-collector-contrib/extension/httpforwarder v0.92.0
github.com/open-telemetry/opentelemetry-collector-contrib/extension/jaegerremotesampling v0.92.0
github.com/open-telemetry/opentelemetry-collector-contrib/extension/oauth2clientauthextension v0.92.0
Expand Down Expand Up @@ -825,6 +826,8 @@ replace github.com/open-telemetry/opentelemetry-collector-contrib/processor/reso

replace github.com/open-telemetry/opentelemetry-collector-contrib/extension/healthcheckextension => ../../extension/healthcheckextension

replace github.com/open-telemetry/opentelemetry-collector-contrib/extension/healthcheckextensionv2 => ../../extension/healthcheckextensionv2

replace github.com/open-telemetry/opentelemetry-collector-contrib/extension/headerssetterextension => ../../extension/headerssetterextension

replace github.com/open-telemetry/opentelemetry-collector-contrib/exporter/googlemanagedprometheusexporter => ../../exporter/googlemanagedprometheusexporter
Expand Down
1 change: 1 addition & 0 deletions extension/healthcheckextensionv2/Makefile
@@ -0,0 +1 @@
include ../../Makefile.Common

0 comments on commit 6587834

Please sign in to comment.