You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: content/en/docs/deployment/mendix-cloud-deploy/monitoring-with-apm/_index.md
+9-9Lines changed: 9 additions & 9 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -12,17 +12,17 @@ There are several application performance monitoring (APM) tools for cloud appli
12
12
13
13
Mendix provides out-of-the-box configuration to use Datadog, AppDynamics, Dynatrace, Splunk Cloud Platform, and New Relic to provide additional monitoring for your Mendix Apps running on Mendix Cloud.
14
14
15
-
{{% alert color="info" %}}
16
-
[AppDynamics](https://www.appdynamics.com/) application monitoring is fully supported in Mendix 9.7 and above. For older supported versions, only the basic AppDynamics Java Agent metrics are available, along with the `postgresql` and `mx.client` namespaces.
17
-
18
-
[Dynatrace](https://www.dynatrace.com/) OneAgent is used to collect metrics. Additionally, in Mendix 9.7 and above, custom application runtime and database metrics are supported.
15
+
The table below summarizes the monitoring capabilities each tool supports:
19
16
20
-
[Datadog](https://www.datadoghq.com/) logging and application metrics are supported in Mendix 7.15 and above.
17
+
| APM Tool | Logs | Metrics | Traces | Min. Mendix Version |
[Splunk Cloud Platform](https://www.splunk.com/en_us/products/splunk-cloud-platform.html) is supported for analyzing runtime application logs.
23
-
24
-
[New Relic](https://www.newrelic.com/) logging and application metrics are supported in Mendix 9.7 and above. Custom application runtime and database metrics are supported.
25
-
{{% /alert %}}
25
+
<small>¹ Logs and metrics are available from Mendix 7.15 and above. Tracing requires Mendix 10.24.12 or 11.5 and above.</small>
26
26
27
27
This document explains what information can be provided to a SaaS-based data analytics platform.
Copy file name to clipboardExpand all lines: content/en/docs/deployment/mendix-cloud-deploy/monitoring-with-apm/datadog-metrics.md
+66-6Lines changed: 66 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -136,7 +136,7 @@ The activity name will be one of the following reported activities:
136
136
137
137
You can use this information during performance optimization. Even when you cannot identify the exact activity (for example, if there are several different `retrieveObject` activities in the same microflow), you can still use this information to identify which activities might be related to trends in performance. You can also use it to compare performance between different versions or environment configurations.
138
138
139
-
### Custom Tags
139
+
### Custom Tags{#custom-tags}
140
140
141
141
If you use Datadog to monitor more than one app and environment, you will not be able to tell which app or environment these metrics apply to. To identify the metrics for your app and environment in Datadog, you need to add tags for the app name and environment.
142
142
@@ -162,18 +162,77 @@ Setting these values for your app causes all metrics from this environment of yo
162
162
You can add more tags if you want, but note that Datadog may charge for custom metrics. For more information, see [Custom Metrics Billing](https://docs.datadoghq.com/account_management/billing/custom_metrics) on the Datadog site.
163
163
{{% /alert %}}
164
164
165
+
Tags you set here also influence Mendix's pre-configured Datadog variables. In particular, if you include a `service:`, `env:`, or `version:` tag, Mendix uses those values when automatically configuring [Unified Service Tagging](https://docs.datadoghq.com/getting_started/tagging/unified_service_tagging/) for your app. See [Pre-configured Variables](#pre-configured-variables) for details.
When Datadog is enabled for your Mendix app, Mendix automatically configures a set of Datadog variables on your behalf. Understanding these helps you avoid unexpected behavior and allows you to override them where needed.
170
+
171
+
Mendix sets the following [Unified Service Tagging](https://docs.datadoghq.com/getting_started/tagging/unified_service_tagging/) variables automatically, deriving their values from your app's configuration:
172
+
173
+
*`DD_SERVICE` – defaults to your app's name, derived from its domain. You can override this by setting a `service:<name>` tag (for example, `service:customermanagement`) on the **Tags** tab of your environment.
174
+
*`DD_ENV` – set from the `env:` tag if present.
175
+
*`DD_VERSION` – set from the `version:` tag if present; otherwise defaults to the Mendix model version of your application.
The following variables are set automatically by Mendix when your app starts. Some can be overridden using [Custom Environment Variables](/developerportal/deploy/environments-details/#custom-environment-variables) if you need different values.
180
+
181
+
| Variable | Automatically Set To | Can Be Overridden? | Description |
182
+
| --- | --- | --- | --- |
183
+
|`DD_SERVICE`| Defaults to your app's name, derived from its domain. Override via a `service:` tag on the Tags tab. | Yes | Identifies your app as a service in Datadog. Used by APM and Unified Service Tagging. |
184
+
|`DD_ENV`| Value of `env:` tag | Yes | Identifies the environment (for example, `production`, `accp`). Used by Unified Service Tagging. |
185
+
|`DD_VERSION`| Value of `version:` tag, or the Mendix model version | Yes | Identifies the deployed version of your app. Used by Unified Service Tagging. |
186
+
|`DD_TAGS`| All tags from the Tags tab | Yes | Sent as global tags on all metrics, traces, and logs submitted to Datadog. |
187
+
|`DD_HOSTNAME`|`<application-domain>-<pod-name-suffix>` (for example, `customermanagement-accp.mendixcloud.com-c25sj` or `customermanagement.mendixcloud.com-6pxlk`) | No | The hostname shown in Datadog for your app. |
188
+
|`DD_LOGS_ENABLED`|`true`| No | Enables log forwarding to Datadog. |
189
+
|`DD_JMXFETCH_ENABLED`|`true`| No | Enables JMX metric collection from the Mendix runtime via the Datadog Java trace agent. |
190
+
|`DD_SERVICE_MAPPING`|`<database>:<app>.db`| No | Links your database service to your app in Datadog APM, so database calls appear correlated in traces. |
191
+
192
+
{{% alert color="info" %}}
193
+
Variables marked **No** in the **Can Be Overridden?** column are fixed by Mendix and cannot be changed via Custom Environment Variables.
To view metrics for multiple instances of an application on the Datadog dashboard, follow these steps:
168
199
169
-
1. In Datadog, go to **Metrics**>**Explorer**.
200
+
1. In Datadog, go to **Metrics**and click**Explorer**.
170
201
2. In the search form, search for your desired metric.
171
202
3. In the **from** field, specify your desired app environment's **Environment ID**. Use the format `application_name:<environment id>`.
172
-
4. In the **avg by** field, select **instance_index**.
203
+
4. In the **avg by** field, select **pod_name**.
204
+
205
+
{{< figure src="/attachments/deployment/mendix-cloud-deploy/metrics/datadog-metrics/datadog-metrics-explorer.png" alt="Metrics Explorer search form" >}}
206
+
207
+
If the app has more than one instance, you will see lines on the graph for each instance.
208
+
209
+
## Mendix Tracing{#mendix-tracing}
210
+
211
+
[Mendix Tracing](/refguide/tracing-in-runtime/) sends Mendix Runtime traces to [Datadog APM](https://docs.datadoghq.com/tracing/), giving you distributed tracing visibility into your app's performance and microflow executions.
212
+
213
+
{{% alert color="info" %}}
214
+
Mendix Tracing requires Mendix Runtime 10.24.12 or above, or 11.5 or above.
215
+
{{% /alert %}}
216
+
217
+
{{% alert color="warning" %}}
218
+
Enabling Mendix Tracing may significantly affect your Datadog APM costs. Review the [Datadog APM billing page](https://docs.datadoghq.com/account_management/billing/apm_tracing_profiler/) before enabling this feature in production.
219
+
{{% /alert %}}
220
+
221
+
### Enabling Tracing{#enable-tracing}
222
+
223
+
To enable Mendix Tracing, follow these steps:
224
+
225
+
1. From [Apps](https://sprintr.home.mendix.com), go to the **Environments** page of your app.
226
+
2. Click **Details** on the environment you want to monitor.
227
+
3. Switch to the **Runtime** tab.
228
+
4. Click **Add** in the **Custom Environment Variables** section.
229
+
5. Set **Name** to `MX_TRACING_ENABLED` and **Value** to `true`.
230
+
6. Click **Save**.
231
+
7. Redeploy your app into the selected environment.
173
232
174
-
{{< figure src="/attachments/deployment/mendix-cloud-deploy/metrics/datadog-metrics/datadog-metrics-explorer.png" alt="Metrics Explorer search form" class="no-border" >}}
233
+
### Filtering Traces{#filter-traces}
175
234
176
-
If the app has more than one instance, you will see lines on the graph for each instance.
235
+
To control which traces are sent to Datadog, set the `MX_TRACING_FILTER` custom environment variable. For available filter options and syntax, see [Tracing in Runtime](/refguide/tracing-in-runtime/#filtering).
177
236
178
237
## Additional Information{#additional-info}
179
238
@@ -213,7 +272,7 @@ You can find the correct type and unit for submitted metrics in the GitHub repo
213
272
214
273
### System Metrics{#system-metrics}
215
274
216
-
System metrics are disabled by default as they usually reflect metrics for a host, rather than for a specific container. You can enable these additional metrics by creating a `DD_ENABLE_CHECKS` custom environment variable and setting its value to `true`. (By default, this variable is set to `false`.)
275
+
System metrics are disabled as they usually reflect metrics for a host, rather than for a specific application container.
217
276
218
277
### Datadog Events Explorer
219
278
@@ -246,6 +305,7 @@ Previously, when Mendix Cloud ran on Cloud Foundry, hosts were incorrectly regis
246
305
247
306
*[Monitor Your Mendix Apps with Datadog](https://www.mendix.com/blog/monitor-your-mendix-apps-with-datadog/) – a Mendix blog about the capabilities of Datadog and using Datadog with Mendix
248
307
*[Metrics](/developerportal/operate/metrics/)
308
+
*[Tracing in Runtime](/refguide/tracing-in-runtime/) – Mendix documentation
0 commit comments