diff --git a/gcp-resources/README.md b/gcp-resources/README.md index 256b898f4..cc7edd544 100644 --- a/gcp-resources/README.md +++ b/gcp-resources/README.md @@ -49,6 +49,12 @@ spec: Additionally, the container name will only be discovered via the environment variable `CONTAINER_NAME` which much be included in the environment. +## Usage with Manual Instrumentation + +It is recommended to use this resource detector with the [OpenTelemetry Autoconfiguration SPI](https://github.com/open-telemetry/opentelemetry-java/blob/main/sdk-extensions/autoconfigure/README.md#resource-provider-spi). The GCP resource detector automatically provides the detected resources via the [autoconfigure-spi](https://github.com/open-telemetry/opentelemetry-java/tree/main/sdk-extensions/autoconfigure-spi) SDK extension. + +For a reference example showcasing the detected resource attributes and usage with `autoconfigure-spi`, see the [Resource detection example](https://github.com/open-telemetry/opentelemetry-java-examples/tree/main/resource-detection-gcp). + ## Usage with Auto-Instrumentation With the release of [v2.2.0 of the OpenTelemetry Java Instrumentation](https://github.com/open-telemetry/opentelemetry-java-instrumentation/releases/tag/v2.2.0), the GCP resource detector is now included with the Java agent.