Skip to content

Commit d51091d

Browse files
authored
Merge pull request #9369 from denis-shuvalov/development
New env. variables description added for Splunk and New Relic integrations
2 parents 9dd7a53 + 37c8433 commit d51091d

File tree

4 files changed

+23
-13
lines changed

4 files changed

+23
-13
lines changed

content/en/docs/deployment/mendix-cloud-deploy/monitoring-with-apm/newrelic-metrics.md

+12-10
Original file line numberDiff line numberDiff line change
@@ -39,22 +39,24 @@ To make use of New Relic, you need a New Relic API key. To find an existing key
3939
To send your runtime information to New Relic, you must provide the New Relic API key to your environment.
4040

4141
1. From [Apps](https://sprintr.home.mendix.com), go to the **Environments** page of your app.
42-
1. Click **Details** on the environment you wish to monitor with New Relic.
42+
1. Click **Details** on the environment you wish to monitor with New Relic.
4343
1. Switch to the **Runtime** tab.
4444
1. Add the following **Custom Environment Variables**:
4545

46-
| Variable | Description |
47-
| --- | --- |
48-
| `NEW_RELIC_LICENSE_KEY` | License key or API key from New Relic. Obtained in the [New Relic API Key](#newrelic-api-key) section.
49-
| `NEW_RELIC_LOGS_URI` | URI for the New Relic's Logs API. For more information, consult [New Relic Regions](#uri-regions). Example: `https://log-api.eu.newrelic.com/log/v1`. |
50-
| `NEW_RELIC_METRICS_URI` | URI for the New Relic's Metrics API. For more information, consult [New Relic Regions](#uri-regions). Example: `https://metric-api.eu.newrelic.com/metric/v1`. |
51-
| `NEW_RELIC_APP_NAME` (optional) | Mendix Application name shown on New Relic's APM & Services. Default: Domain host name. |
52-
| `LOGS_REDACTION` (optional) | Email addresses are automatically redacted before log entries are sent to New Relic. To disable this redaction, set `LOGS_REDACTION` to `false`. Default: `true`. |
46+
| Variable | Description | Default |
47+
| --- | --- | --- |
48+
| `NEW_RELIC_LICENSE_KEY` | License key or API key from New Relic. Obtained in the [New Relic API Key](#newrelic-api-key) section. | |
49+
| `NEW_RELIC_LOGS_URI` | URI for the New Relic's Logs API. For more information, consult [New Relic Regions](#uri-regions). Example: `https://log-api.eu.newrelic.com/log/v1`. | |
50+
| `NEW_RELIC_METRICS_URI` | URI for the New Relic's Metrics API. For more information, consult [New Relic Regions](#uri-regions). Example: `https://metric-api.eu.newrelic.com/metric/v1`. | |
51+
| `NEW_RELIC_APP_NAME` (optional) | Mendix Application name shown on New Relic's APM & Services. Default: Domain host name. | |
52+
| `LOGS_REDACTION` (optional) | Email addresses are automatically redacted before log entries are sent to New Relic. To disable this redaction, set `LOGS_REDACTION` to `false`. Default: `true`. ||
53+
| `FLUENTBIT_LOGS_BUFFER_SIZE` | Sets the maximum amount of data (in KB) that the TCP input plugin reads from the socket per read operation. Increasing this value can help to get rid of data flow delay, and errors related to queue buffer overflow. | `128` |
54+
| `FLUENTBIT_LOGS_MEM_BUF_LIMIT` | Defines the maximum total memory an input plugin can use for buffering log records before they are processed or flushed to storage/output. Limits memory which can be consumed by the Fluentbit agent | `50MB` |
5355

5456
1. Return to the **Environments** page for your app and **Deploy** or **Transport** your app into the selected environment.
5557

5658
{{% alert color="warning" %}}To start sending data to New Relic, you must redeploy your app and then restart it. Just restarting the app is not sufficient because additional dependencies need to be included.{{% /alert %}}
57-
59+
5860
## Tagging Metrics for New Relic
5961

6062
To help you with analyzing your app metrics as described in the [App Metrics](/developerportal/operate/monitoring-with-apm/#app-metrics) section of *Monitoring Your Mendix Apps with an APM Tool*, Mendix adds tags to metrics from microflows and activities when using New Relic.
@@ -84,7 +86,7 @@ Mendix recommends using the following tags:
8486
To set these tags, do the following:
8587

8688
1. From [Apps](https://sprintr.home.mendix.com), go to the **Environments** page of your app.
87-
1. Click **Details** on an environment you are monitoring with New Relic.
89+
1. Click **Details** on an environment you are monitoring with New Relic.
8890
1. On the **Tags** tab, add a tag. This is the string that is sent to New Relic as a tag.
8991
1. Restart the app.
9092

content/en/docs/deployment/mendix-cloud-deploy/monitoring-with-apm/splunk-metrics.md

+4-2
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ To use the Splunk Cloud Platform and send data to Splunk Cloud Platform from you
3232
To send your runtime information to Splunk Cloud Platform, you need to set it up using environment variables in the Mendix Portal.
3333

3434
1. From [Apps](https://sprintr.home.mendix.com), go to the **Environments** page of your app.
35-
1. Click **Details** on the environment you wish to monitor with Splunk Cloud Platform.
35+
1. Click **Details** on the environment you wish to monitor with Splunk Cloud Platform.
3636
1. Switch to the [**Runtime** tab](/developerportal/deploy/environments-details/#runtime-tab).
3737
1. Add the following **Custom Environment Variables**.
3838

@@ -42,6 +42,8 @@ To send your runtime information to Splunk Cloud Platform, you need to set it up
4242
| `SPLUNK_PORT` | The HTTP (or HTTPS) port of the Splunk Cloud Platform Controller. | `8088` |
4343
| `SPLUNK_TOKEN` | An access token to the Splunk Cloud Platform. To create a new token on the Splunk Cloud dashboard, open the Splunk Cloud dashboard in a browser, go to **Settings** > **Data Input** > **HTTP Event Collector**, and click **New Token** (on the upper-right corner of the page). | |
4444
| `LOGS_REDACTION` | Email addresses are automatically redacted before log entries are sent to Splunk Cloud Platform. To disable this redaction, set `LOGS_REDACTION` to `false`. The environment variable `SPLUNK_LOGS_REDACTION` is still supported, but it is now deprecated and will be removed in a later version. Its use is not recommended. | `true` |
45+
| `FLUENTBIT_LOGS_BUFFER_SIZE` | Sets the maximum amount of data (in KB) that the TCP input plugin reads from the socket per read operation. Increasing this value can help to get rid of data flow delay, and errors related to queue buffer overflow. | `128` |
46+
| `FLUENTBIT_LOGS_MEM_BUF_LIMIT` | Defines the maximum total memory an input plugin can use for buffering log records before they are processed or flushed to storage/output. Limits memory which can be consumed by the Fluentbit agent | `50MB` |
4547

4648
1. Return to the **Environments** page for your app and **Deploy** or **Transport** your app into the selected environment.
4749

@@ -70,7 +72,7 @@ You can also set up custom tags in the format `key:value`. Mendix recommends add
7072
To set these tags, do the following:
7173

7274
1. From [Apps](https://sprintr.home.mendix.com), go to the **Environments** page of your app.
73-
1. Click **Details** on an environment you are monitoring with Splunk.
75+
1. Click **Details** on an environment you are monitoring with Splunk.
7476
1. Switch to the **Tags** tab.
7577
1. Click **Add** and type in the string to be sent to Splunk as a tag.
7678
1. Restart the app.

content/en/docs/releasenotes/deployment/_index.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ Follow the links in the table below to see the release notes you want:
1515

1616
| Type of Deployment | Last Updated |
1717
| --- | --- |
18-
| [Mendix Cloud](/releasenotes/developer-portal/mendix-cloud/) | February 27, 2025 |
18+
| [Mendix Cloud](/releasenotes/developer-portal/mendix-cloud/) | April 17, 2025 |
1919
| [Mendix for Private Cloud](/releasenotes/developer-portal/mendix-for-private-cloud/) | March 20, 2025 |
2020
| [Mendix on Azure](/releasenotes/developer-portal/mendix-on-azure/) | March 20, 2025 |
2121
| [SAP Business Technology Platform (SAP BTP)](/releasenotes/developer-portal/sap-cloud-platform/) | August 27, 2024 |

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

+6
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,12 @@ For information on the current status of deployment to Mendix Cloud and any plan
1616

1717
## 2025
1818

19+
### April 17, 2025
20+
21+
#### Improvements
22+
23+
* We have added new environment variables which allow you to control the buffer size and buffer memory for the Fluentbit agent for Splunk and New Relic.
24+
1925
### February 27, 2025
2026

2127
#### Improvements

0 commit comments

Comments
 (0)