diff --git a/extension/healthcheckextension/README.md b/extension/healthcheckextension/README.md index 4f0bb27d15b2..b88b5ecb0250 100644 --- a/extension/healthcheckextension/README.md +++ b/extension/healthcheckextension/README.md @@ -1,9 +1,15 @@ # Health Check -| Status | | -| ------------------------ |-----------------------| -| Stability | [beta] | -| Distributions | [contrib] | + +| Status | | +| ------------------------ |-----------| +| Stability | [beta] | +| Distributions | [core], [contrib] | + +[beta]: https://github.com/open-telemetry/opentelemetry-collector#beta +[core]: https://github.com/open-telemetry/opentelemetry-collector-releases/tree/main/distributions/otelcol +[contrib]: https://github.com/open-telemetry/opentelemetry-collector-releases/tree/main/distributions/otelcol-contrib + Health Check extension enables an HTTP url that can be probed to check the status of the OpenTelemetry Collector. This extension can be used as a @@ -46,6 +52,3 @@ extensions: The full list of settings exposed for this exporter is documented [here](./config.go) with detailed sample configurations [here](./testdata/config.yaml). - -[beta]: https://github.com/open-telemetry/opentelemetry-collector#beta -[contrib]: https://github.com/open-telemetry/opentelemetry-collector-releases/tree/main/distributions/otelcol-contrib diff --git a/extension/healthcheckextension/doc.go b/extension/healthcheckextension/doc.go index 97630ba5025e..ab84c41e6c45 100644 --- a/extension/healthcheckextension/doc.go +++ b/extension/healthcheckextension/doc.go @@ -12,6 +12,8 @@ // See the License for the specific language governing permissions and // limitations under the License. +//go:generate mdatagen metadata.yaml + // Package healthcheckextension implements an extension that enables an HTTP // endpoint that can be used to check the overall health and status of the // service. diff --git a/extension/healthcheckextension/factory.go b/extension/healthcheckextension/factory.go index 8354e591d74c..99c2930bbc0f 100644 --- a/extension/healthcheckextension/factory.go +++ b/extension/healthcheckextension/factory.go @@ -20,6 +20,8 @@ import ( "go.opentelemetry.io/collector/component" "go.opentelemetry.io/collector/config/confighttp" "go.opentelemetry.io/collector/extension" + + "github.com/open-telemetry/opentelemetry-collector-contrib/extension/healthcheckextension/internal/metadata" ) const ( @@ -37,7 +39,7 @@ func NewFactory() extension.Factory { typeStr, createDefaultConfig, createExtension, - component.StabilityLevelBeta, + metadata.Stability, ) } diff --git a/extension/healthcheckextension/internal/metadata/generated_status.go b/extension/healthcheckextension/internal/metadata/generated_status.go new file mode 100644 index 000000000000..c53c077163cc --- /dev/null +++ b/extension/healthcheckextension/internal/metadata/generated_status.go @@ -0,0 +1,9 @@ +// Code generated by mdatagen. DO NOT EDIT. + +package metadata + +import ( + "go.opentelemetry.io/collector/component" +) + +const Stability = component.StabilityLevelBeta diff --git a/extension/healthcheckextension/metadata.yaml b/extension/healthcheckextension/metadata.yaml new file mode 100644 index 000000000000..1e3c0c50b5f6 --- /dev/null +++ b/extension/healthcheckextension/metadata.yaml @@ -0,0 +1,6 @@ +name: healthcheck + +status: + type: extension + stability: beta + distributions: [core, contrib]