[DOCS-9826] azure container apps sidecar #27145
Open
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
github-actions
bot
added
Images
Preview links (active after the
|
cswatt
added
editorial review
|
Added DOCS-9890 to track review |
brett0000FF
approved these changes
Jan 17, 2025
There was a problem hiding this comment.
@cswatt - This looks great! I just left a few minor suggestions for your consideration. 🚀
| {{< tabs >}} | ||
| {{% tab "Node.js" %}} | ||
| #### Tracing | ||
| Instrument your main application with the `dd-trace-js` library. See [Tracing Node.js Applications][1] for instructions. |
There was a problem hiding this comment.
Suggested change
| Instrument your main application with the `dd-trace-js` library. See [Tracing Node.js Applications][1] for instructions. | |
| Instrument your main application with the `dd-trace-js` library. See [Tracing Node.js applications][1] for instructions. |
Small nit but this is lowercase for all of the other languages.
| | Name | Description | | ||
| | ---- | ----------- | | ||
| | `DD_AZURE_SUBSCRIPTION_ID` | **Required**. Your Azure subscription ID. | | ||
| | `DD_AZURE_SUBSCRIPTION_ID` | **Required**. Your Azure resource group. | |
There was a problem hiding this comment.
Suggested change
| | `DD_AZURE_SUBSCRIPTION_ID` | **Required**. Your Azure resource group. | | |
| | `DD_AZURE_RESOURCE_GROUP` | **Required**. Your Azure resource group. | |
I am assuming this is the correct env variable but please double check!
| 3. In the **Add a container** form, provide the following: | ||
| - **Name**: `datadog` | ||
| - **Image source**: Docker Hub or other registries | ||
| - **Image type**: Public |
There was a problem hiding this comment.
Suggested change
| - **Image type**: Public | |
| - **Image type**: `Public` |
| - `DD_API_KEY`: Datadog API key, used to send data to your Datadog account. It should be configured as a [Azure Secret][7] for privacy and safety issue. | ||
| - `DD_SITE`: Datadog endpoint and website. Select your site on the right side of this page. Your site is: {{< region-param key="dd_site" code="true" >}}. | ||
| - **`DD_AZURE_SUBSCRIPTION_ID`**: The Azure Subscription ID associated with the Container App resource (Required). | ||
| - **`DD_AZURE_RESOURCE_GROUP`**: The Azure Resouce Group associated with the Container App resource (Required). |
There was a problem hiding this comment.
Suggested change
| - **`DD_AZURE_RESOURCE_GROUP`**: The Azure Resouce Group associated with the Container App resource (Required). | |
| - **`DD_AZURE_RESOURCE_GROUP`**: The Azure Resource Group associated with the Container App resource (Required). |
|
|
||
| - **Logs:** If you use the [Azure integration][1], your logs are already being collected. Alternatively, you can set the `DD_LOGS_ENABLED` environment variable to `true` to capture application logs through the serverless instrumentation directly. | ||
|
|
||
| - **Custom Metrics:** You can submit custom metrics using a [DogStatsd client][3]. For monitoring Cloud Run and other serverless applications, use [distribution][8] metrics. Distributions provide `avg`, `sum`, `max`, `min`, and `count` aggregations by default. On the Metric Summary page, you can enable percentile aggregations (p50, p75, p90, p95, p99) and also manage tags. To monitor a distribution for a gauge metric type, use `avg` for both the [time and space aggregations][9]. To monitor a distribution for a count metric type, use `sum` for both the time and space aggregations. |
There was a problem hiding this comment.
Suggested change
| - **Custom Metrics:** You can submit custom metrics using a [DogStatsd client][3]. For monitoring Cloud Run and other serverless applications, use [distribution][8] metrics. Distributions provide `avg`, `sum`, `max`, `min`, and `count` aggregations by default. On the Metric Summary page, you can enable percentile aggregations (p50, p75, p90, p95, p99) and also manage tags. To monitor a distribution for a gauge metric type, use `avg` for both the [time and space aggregations][9]. To monitor a distribution for a count metric type, use `sum` for both the time and space aggregations. | |
| - **Custom Metrics:** You can submit custom metrics using a [DogStatsD client][3]. For monitoring Cloud Run and other serverless applications, use [distribution][8] metrics. Distributions provide `avg`, `sum`, `max`, `min`, and `count` aggregations by default. On the Metric Summary page, you can enable percentile aggregations (p50, p75, p90, p95, p99) and also manage tags. To monitor a distribution for a gauge metric type, use `avg` for both the [time and space aggregations][9]. To monitor a distribution for a count metric type, use `sum` for both the time and space aggregations. |
|
|
||
| ## Instrument your application | ||
|
|
||
| You can instrument your application in one of two ways: [Dockerfile](#dockerfile) or [buildpack](#buildpack). |
There was a problem hiding this comment.
There doesn't seem to be a buildpack section. Where is this supposed to link?
| ### 2. Configure your application | ||
|
|
||
| Once the container is built and pushed to your registry, the last step is to set the required environment variables for the Datadog Agent: | ||
| - `DD_API_KEY`: Datadog API key, used to send data to your Datadog account. It should be configured as a [Azure Secret][7] for privacy and safety issue. |
There was a problem hiding this comment.
Suggested change
| - `DD_API_KEY`: Datadog API key, used to send data to your Datadog account. It should be configured as a [Azure Secret][7] for privacy and safety issue. | |
| - `DD_API_KEY`: Datadog API key, used to send data to your Datadog account. It should be configured as an [Azure Secret][7] for privacy and safety issue. |
|
|
||
| - **Custom Metrics:** You can submit custom metrics using a [DogStatsd client][3]. For monitoring Cloud Run and other serverless applications, use [distribution][8] metrics. Distributions provide `avg`, `sum`, `max`, `min`, and `count` aggregations by default. On the Metric Summary page, you can enable percentile aggregations (p50, p75, p90, p95, p99) and also manage tags. To monitor a distribution for a gauge metric type, use `avg` for both the [time and space aggregations][9]. To monitor a distribution for a count metric type, use `sum` for both the time and space aggregations. | ||
|
|
||
| - **Trace Sampling:** To manage the APM traced request sampling rate for serverless applications, set the DD_TRACE_SAMPLE_RATE environment variable on the function to a value between 0.000 (no tracing of Container App requests) and 1.000 (trace all Container App requests). |
There was a problem hiding this comment.
Suggested change
| - **Trace Sampling:** To manage the APM traced request sampling rate for serverless applications, set the DD_TRACE_SAMPLE_RATE environment variable on the function to a value between 0.000 (no tracing of Container App requests) and 1.000 (trace all Container App requests). | |
| - **Trace Sampling:** To manage the APM traced request sampling rate for serverless applications, set the `DD_TRACE_SAMPLE_RATE` environment variable on the function to a value between 0.000 (no tracing of Container App requests) and 1.000 (trace all Container App requests). |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What does this PR do? What is the motivation?
Merge instructions
Merge readiness:
Merge queue is enabled in this repo. To have it automatically merged after it receives the required reviews, create the PR (from a branch that follows the
<yourname>/descriptionnaming convention) and then add the following PR comment:Additional notes