Datadog Serverless CLI for Cloud Run
このページは日本語には対応しておりません。随時翻訳に取り組んでいます。
翻訳に関してご質問やご意見ございましたら、
お気軽にご連絡ください。
You can use the CLI to instrument your Cloud Run services with Datadog. The CLI enables instrumentation by modifying existing Cloud Run services’ configuration.
Commands
instrument
Run datadog-ci cloud-run instrument to apply Datadog instrumentation to a Cloud Run service. This command adds a sidecar container, a shared log volume, and adds required environment variables.
datadog-ci cloud-run instrument -p <gcp-project> -r us-central1 -s <service-name> -s <another-service-name>
# Instrument a service in interactive mode
datadog-ci cloud-run instrument -i
# Instrument a service with a pinned or custom sidecar image
datadog-ci cloud-run instrument -p <gcp-project> -r us-central1 -s <service-name> --sidecarImage gcr.io/datadoghq/serverless-init@sha256:<sha256>
# Dry run of all updates
datadog-ci cloud-run instrument -p <gcp-project> -r us-central1 -s <service-name> -d
uninstrument
Run datadog-ci cloud-run uninstrument to revert Datadog instrumentation from a Cloud Run service. This command updates the configuration by removing the sidecar container, the shared log volume, and Datadog environment variables.
# Uninstrument multiple services specified by names
datadog-ci cloud-run instrument -p <gcp-project> -r us-central1 -s <service-name> -s <another-service-name>
# Uninstrument a service in interactive mode
datadog-ci cloud-run uninstrument -i
# Dry run of all updates
datadog-ci cloud-run uninstrument -p <gcp-project> -r us-central1 -s <service-name> -d
Configuration
GCP credentials
You must have valid GCP credentials configured with access to the Cloud Run services where you are running any datadog-ci cloud-run command. You can configure credentials by running gcloud auth application-default login and following the prompts in your browser.
Environment variables
You must expose these environment variables in the environment where you are running datadog-ci cloud-run instrument:
| Environment Variable | Description | Example |
|---|
DD_API_KEY | Datadog API Key. Sets the DD_API_KEY environment variable on your Cloud Run service. | export DD_API_KEY=<API_KEY> |
DD_SITE | Set which Datadog site to send data. Possible values are datadoghq.com, datadoghq.eu, us3.datadoghq.com, us5.datadoghq.com, ap1.datadoghq.com, ap2.datadoghq.com, and ddog-gov.com. The default is datadoghq.com. | export DD_SITE=datadoghq.com |
Arguments
Configuration can be done using command-line arguments.
instrument
You can pass the following arguments to instrument to specify its behavior.
| Argument | Shorthand | Description | Default |
|---|
--project | -p | The GCP project ID where your Cloud Run service is located. | |
--service | -s | The name of your Cloud Run service. | |
--region | -r | The GCP region where your service(s) are deployed in. | |
--dry | -d | Preview the changes that running the command would apply. | false |
--interactive | -i | Interactively choose which service gets instrumented. No need for other flags | false |
--env | | Separate out your staging, development, and production environments. | |
--version | | Add the --version tag to correlate spikes in latency, load, or errors to new versions. | |
--tracing | | Disable tracing by setting --tracing false. | true |
--log-level | | Specify your Datadog log level. | |
--llmobs | | If specified, enables LLM Observability for the instrumented service(s) with the provided ML application name. | |
--extra-tags | | Add custom tags to your Cloud Run service in Datadog. Must be a list of <key:><value> separated by commas. | |
--source-code-integration | | Whether to enable Datadog Source Code Integration. This will tag your service(s) with the Git respository and the latest commit hash of the local direectory. | true |
--no-source-code-integration | | Disables Datadog Source Code Integration. | |
--upload-git-metadata | | Whether to enable Git metadata uploading, as a part of source code integration. Git metadata uploading is only required if you don’t have the Datadog Github Integration installed. | true |
--no-upload-git-metadata | | Disables Git metadata uploading. Use this flag if you have the Datadog Github Integration installed, as it renders Git metadata uploading unnecessary. | |
--health-check-port | | Specify the health check port of your sidecar container. | 5555 |
--sidecar-image | | Specify a custom sidecar image. | gcr.io/datadoghq/serverless-init:latest |
--sidecar-name | | (Not recommended) Specify a custom sidecar container name. | datadog-sidecar |
--shared-volume-name | | (Not recommended) Specify a custom shared volume name. | shared-volume |
--shared-volume-path | | (Not recommended) Specify a custom shared volume path. | /shared-volume |
--logs-path | | (Not recommended) Specify a custom log file path. Must begin with the shared volume path. | /shared-volume/logs/*.log |
--sidecar-cpus | | The number of CPUs to allocate to the sidecar container. | 1 |
--sidecar-memory | | The amount of memory to allocate to the sidecar container. | 512Mi |
--language | | Set the language used in your container or function for advanced log parsing. Sets the DD_SOURCE env var. Possible values: nodejs, python, go, java, csharp, ruby, or php. | |
uninstrument
You can pass the following arguments to uninstrument to specify its behavior.
| Argument | Shorthand | Description | Default |
|---|
--project | -p | The GCP project ID where your Cloud Run service is located. | |
--service | -s | The name of your Cloud Run service. | |
--region | -r | The GCP region where your service(s) are deployed in. | |
--dry | -d | Preview the changes that running the command would apply. | false |
--interactive | -i | Interactively choose which service gets instrumented. No need for other flags | false |
--sidecar-name | | The name of the container to remove. Specify if you have a different sidecar container name. | datadog-sidecar |
--shared-volume-name | | The name of the shared volume to remove. Specify if you have a different shared volume name. | shared-volume |
Troubleshooting Cloud Run instrumentation
To troubleshoot issues you encounter with Datadog monitoring on your Cloud Run services, run the datadog-ci cloud-run flare command in the root of your project directory. This command collects important data about the Cloud Run service, such as environment variables and the YAML config. These files are submitted to Datadog support via a ticket matching the provided Zendesk case ID.
Note: This command works regardless of whether your Cloud Run services were instrumented using datadog-ci cloud-run instrument.
Examples
# Collect and send files to Datadog support for a single service
datadog-ci cloud-run -s <service> -p <project> -r <region/location> -c <case-id> -e <email-on-case-id>
# Include recent logs
datadog-ci cloud-run -s <service> -p <project> -r <region/location> -c <case-id> -e <email-on-case-id> --with-logs
# Dry run: collect data, but don't send to Datadog support
datadog-ci cloud-run -s <service> -p <project> -r <region/location> -c <case-id> -e <email-on-case-id> --with-logs --dry-run
Arguments
| Argument | Shorthand | Description | Default |
|---|
--service | -s | The name of the Cloud Run service. | |
--project | -p | The name of the Google Cloud project where the Cloud Run service is hosted. | |
--region | -r | The region where the Cloud Run service is hosted. | |
--case-id | -c | The Datadog case ID to send the files to. | |
--email | -e | The email associated with the specified case ID. | |
--with-logs | | Collect recent logs for the specified service. | false |
--start and --end | | Only gather logs within the time range (--with-logs must be included.) Both arguments are numbers in milliseconds since Unix Epoch. | |
--dry-run | -d | Preview data that will be sent to Datadog support. | false |
Environment variables
Expose these environment variables in the environment where you are running datadog-ci cloud-run flare:
| Environment Variable | Description | Example |
|---|
DD_API_KEY | Datadog API Key. Used to attach the flare files to your Zendesk ticket. For more information about getting a Datadog API key, see the API key documentation. | export DD_API_KEY=<API_KEY> |
DD_SITE | Optional. Set which Datadog site to send the flare for lower latency. Possible values are datadoghq.com , datadoghq.eu , us3.datadoghq.com, us5.datadoghq.com, ap1.datadoghq.com, ap2.datadoghq.com, and ddog-gov.com. The default is datadoghq.com. | export DD_SITE="datadoghq.com" |
For product feedback and questions, join the #serverless channel in the Datadog community on Slack.
Further reading
Additional helpful documentation, links, and articles:
