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/refguide/runtime/tracing-in-runtime.md
+18-11Lines changed: 18 additions & 11 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -6,7 +6,7 @@ description: "Describes how to setup and use tracing in the Mendix Runtime."
6
6
7
7
## Introduction
8
8
9
-
Mendix now supports tracing via OpenTelemetry. When tracing is enabled, the runtime generates traces that help you analyze errors and performance.
9
+
Mendix supports tracing via OpenTelemetry. When tracing is enabled, the runtime generates traces that help you analyze errors and performance.
10
10
These traces can be sent to observability tools like [Jaeger](https://www.jaegertracing.io/) or [Datadog](https://www.datadoghq.com/).
11
11
12
12
{{% alert color="warning" %}}
@@ -15,7 +15,7 @@ Tracing is currently not supported on Mendix Cloud and Mendix Cloud Dedicated.
15
15
16
16
## Generated spans
17
17
18
-
The runtime generates spans for:
18
+
The runtime generates spans for the following:
19
19
20
20
* Runtime operations coming from the front end, for example, microflow calls, retrieves, commits, and deletes
21
21
* Microflow execution within the runtime, including sub-microflow calls
@@ -26,13 +26,20 @@ The runtime generates spans for:
26
26
27
27
### Minimal Configuration {#min-configuration}
28
28
29
-
Tracing can be enabled from the `App Settings` -> `Configuration` dialog. In the `Tracing` tab, you can enable tracing and specify an **Endpoint** and **Service Name**.
29
+
You can enable tracing from the `App Settings` -> `Configuration` dialog. In the `Tracing` tab, you can enable tracing and specify an **Endpoint** and **Service Name**.
For filtering out specific traces, `mendix.tracing.filter` system property can be used. The specified spans and their sub-spans will be filtered out. `matchType` specifies how the name of the span is matched. Currently only `partial` is supported for `matchType` which checks if the span name contains the provided value.
35
+
{{% alert color="info" %}}
36
+
Filtering was introduced in Mendix 11.5.0.
37
+
{{% /alert %}}
38
+
39
+
You can filter out specific traces using the `mendix.tracing.filter` system property. The specified spans and their sub-spans will be filtered out.
40
+
41
+
`matchType` specifies how the name of the span is matched. The `matchType` must be set to `partial`. This checks if the span name contains the provided value.
42
+
36
43
```json
37
44
[
38
45
{
@@ -43,15 +50,15 @@ For filtering out specific traces, `mendix.tracing.filter` system property can b
43
50
44
51
### Testing
45
52
46
-
To test the tracing you can use [Jaeger](https://www.jaegertracing.io/). For example, the all-in-one binary or Docker image. Jaeger will listen to the above endpoint by default.
53
+
You can test the tracing you using [Jaeger](https://www.jaegertracing.io/). For example, you can use the all-in-one binary or Docker image. Jaeger will listen to endpoint`http://localhost:4318/v1/traces` by default.
47
54
48
55
Alternatively, you can set up the [OpenTelemetry collector](https://opentelemetry.io/docs/collector/), which will also listen to the default endpoint and can be configured to send to backends which support OpenTelemetry. Check with your APM vendor to confirm that OpenTelemetry is supported. The free online collector configuration tool [OTelBin](https://github.com/dash0hq/otelbin) can help with collector configuration.
49
56
50
57
### All settings
51
58
52
-
Below we list the ones that are supported by the Mendix runtime. See [Configure the SDK](https://opentelemetry.io/docs/languages/java/configuration/#environment-variables-and-system-properties) for a reference on the settings that are prefixed with `otel.`.
59
+
The following settings are supported by the Mendix runtime. See [Configure the SDK](https://opentelemetry.io/docs/languages/java/configuration/#environment-variables-and-system-properties) for more information about the settings that are prefixed with `otel.`.
53
60
54
-
The Java Agent can be configured through system properties, which can be added to the **Extra JVM parameters** field (for example, `-Dotel.exporter.otlp.traces.endpoint`), or set through environment variables.
61
+
You can configure the Java Agent through system properties which can be added to the **Extra JVM parameters** field (for example, `-Dotel.exporter.otlp.traces.endpoint`), or set through environment variables.
55
62
56
63
| Name | Description | Default |
57
64
|------|-------------|---------|
@@ -68,7 +75,7 @@ The Java Agent can be configured through system properties, which can be added t
68
75
69
76
## Enabling Tracing for Deployed Applications
70
77
71
-
To enable tracing for your deployed Mendix application, configure the following JVM parameters:
78
+
You enable tracing for your deployed Mendix application, by the following JVM parameters:
@@ -110,20 +117,20 @@ Replace `MyServiceName` with a meaningful identifier for your service, and `coll
110
117
111
118
## Sending Traces to Datadog
112
119
113
-
There are two options for exporting OpenTelemetry traces to Datadog:
120
+
You can export OpenTelemetry traces to Datadog using one of the following two ways:
114
121
115
122
* Datadog Distribution of OpenTelemetry (DDOT)
116
123
* OpenTelemetry Collector
117
124
118
125
### Datadog Distribution of OpenTelemetry (DDOT)
119
126
120
-
DDOT can be deployed to Kubernetes or Linux (Preview). The default setup provides minimal configuration, allowing it to receive OpenTelemetry traces or logs from your Mendix app and send them to Datadog. With this default configuration, the collector listens on the same ports as your Mendix application.
127
+
You can deploy DDOT to Kubernetes or Linux (Preview). The default setup provides minimal configuration, allowing it to receive OpenTelemetry traces or logs from your Mendix app and send them to Datadog. With this default configuration, the collector listens on the same ports as your Mendix application.
121
128
122
129
For installation instructions, refer to the official [DDOT documentation](https://docs.datadoghq.com/opentelemetry/setup/ddot_collector/install).
123
130
124
131
### OpenTelemetry Collector
125
132
126
-
The OpenTelemetry Collector can be installed on various operating systems, including Windows, macOS, and Linux.
133
+
You can install the OpenTelemetry Collector on various operating systems, including Windows, macOS, and Linux.
127
134
128
135
To use the OpenTelemetry Collector with Datadog, follow these steps:
0 commit comments