Merge pull request mendix#6134 from ekremsekerci/LM-127_apm_metrics_filters

Filtering capability for runtime metrics to APMs

Author: MarkvanMents

content/en/docs/developerportal/operate/metrics/monitoring-with-apm/_index.md

@@ -32,8 +32,6 @@ For details on how to add a specific APM tool to your app, see one of the follow
 * [Dynatrace for Mendix Cloud](/developerportal/operate/dynatrace-metrics/)
 * [Splunk for the Mendix Cloud](/developerportal/operate/splunk-metrics/)
 
-A summary of the useful metrics provided by Mendix is in the section [Summary of Mendix Metrics](#summary), below.
-
 {{% alert color="info" %}}
 For support on other cloud deployment options, such as Private Cloud, refer to their dedicated [documentation pages](/developerportal/deploy/private-cloud-monitor/).
 {{% /alert %}}
@@ -272,18 +270,41 @@ You pass the configuration to the metrics agent by adding a *Custom Runtime Sett
 4. Click **Save**.
 5. Restart your app to apply the new settings if you have already connected your node to your data analytics. If you are in the process of connecting your node, you must *redeploy* your application to apply the changes.
 
-## 5 Summary of Mendix Metrics{#summary}
-
-| Metric | Description |
-| --- | --- |
-| jmx.com.mendix.\* | JMX metrics for the `com.mendix` domain (core runtime). |
-| mx.database.diskstorage_size | Disk storage available to the application database (this is a fixed value) |
-| mx.activity.time | How long a microflow activity takes to run |
-| mx.client.time | The time to handle a request to a request handler that is used by the web ui |
-| mx.microflow.time | How long a microflow takes to run |
-| mx.odata.time | The time to handle an OData request |
-| mx.rest.time | The time to handle a REST request |
-| mx.soap.time | The time to handle a SOAP request |
+## 5 Filtering Metrics Ingestion 
+
+{{% alert color="info" %}}
+The metrics collected by APM vendors' agents are not affected by this feature, only runtime metrics collected by Mendix can be filtered.
+{{% /alert %}}
+
+To filter the ingestion of metrics to APM vendors, environment variables listed below can be used.
+
+* [APM_METRICS_FILTER_ALLOW](#app-metrics-filter-allow)
+* [APM_METRICS_FILTER_DENY](#app-metrics-filter-deny)
+* [APM_METRICS_FILTER_DENY_ALL](#app-metrics-filter-deny-all)
+
+{{% alert color="info" %}}
+Database metrics (`postgresql.*` and `mx.database.diskstorage_size`) cannot be filtered by name, to turn them off, the `APPMETRICS_INCLUDE_DB` environment variable can be set to false. 
+{{% /alert %}}
+
+### 5.1 APM_METRICS_FILTER_ALLOW{#app-metrics-filter-allow}
+
+Comma-separated list of prefixes for the metrics to be allowed. By default, all metrics are allowed, even if they are not specified via this environment variable.
+
+For example, to allow only the session and the jvm metrics, the environment variable should be set to `mx.runtime.stats.sessions,jvm`.
+
+
+### 5.2 APM_METRICS_FILTER_DENY{#app-metrics-filter-deny}
+
+Comma-separated list of prefixes for the metrics to be denied. 
+
+For example, to filter out only metrics starting with jetty or mx.runtime, the environment variable should be set to `jetty,mx.runtime`.
+
+
+### 5.3 APM_METRICS_FILTER_DENY_ALL{#app-metrics-filter-deny-all}
+
+This environment variable can be used to stop ingestion of all metrics at once.
+
+If it is set to `true`, all metrics will be denied regardless of the values of `APM_METRICS_FILTER_ALLOW`, `APM_METRICS_FILTER_DENY`, and `APPMETRICS_INCLUDE_DB`.
 
 ## 6 Read More
 

content/en/docs/releasenotes/deployment/mendix-cloud.md

@@ -23,6 +23,10 @@ For information on the current status of deployment to Mendix Cloud and any plan
 
 * The webhooks feature is now released for GA. Webhooks can trigger endpoints when changes are committed to a Team Server Git repository, or when a new deployment package is available for deployment to the Mendix Cloud. For more information, see [Webhooks](/developerportal/deploy/webhooks/).
 
+#### Improvements
+
+* We have introduced a filtering capability for sending Mendix runtime metrics to APM vendors.
+
 ### May 4th, 2023
 
 * In the Build and Deploy APIs, we have added a link to download packages from the Developer Portal. This is controlled by a parameter on the following API calls: