Skip to content

Commit 97b9aad

Browse files
committed
Add gateway APM document
1 parent a919525 commit 97b9aad

File tree

2 files changed

+40
-4
lines changed

2 files changed

+40
-4
lines changed

articles/spring-apps/how-to-configure-enterprise-spring-cloud-gateway.md

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -152,6 +152,40 @@ The following table describes the default resource usage:
152152
| VMware Spring Cloud Gateway | 2 | 1 core | 2Gi |
153153
| VMware Spring Cloud Gateway operator | 2 | 1 core | 2Gi |
154154

155+
## Configure Application Performance Monitoring
156+
157+
There are several types of Application Performance Monitoring (APM) Java agents provided by Spring Cloud Gateway to monitor gateway managed by Azure Spring Apps. Use the two configurations to setup APM for Spring Cloud Gateway.
158+
159+
#### [Portal](#tab/Azure-portal)
160+
161+
The following steps are to set up APM using the Azure portal.
162+
163+
1. Open the **Spring Cloud Gateway** page and select **Configuration** tabs.
164+
165+
1. Choose the APM type to monitor gateway in the dropdown list of **APM**.
166+
167+
1. Fill the key-value pairs environment variables of APM in the **Properties** or **Secrets**. You can put variables with sensitive information in **Secrets**.
168+
169+
1. When all configurations provided, select **Save** at the bottom to save your changes.
170+
171+
Updating the configuration can take a few minutes. You should get a notification when the configuration is complete.
172+
173+
#### [CLI](#tab/Azure-CLI)
174+
175+
The following steps use the Azure CLI to set up APM.
176+
177+
Run the following command
178+
179+
```azurecli
180+
az spring gateway update --apm-types <APM_TYPE> --properties <key=value> --secrets <key=value>
181+
```
182+
183+
The supported APM types are `ApplicationInsights`, `AppDynamics`, `Dynatrace`, `NewRelic` and `ElasticAPM`. You can refer to their public documents about APM Java agent to see full functions provided and which environment variables are exposed. Azure Spring Apps will upgrade APM agents version in the same cadence as those in Buildpacks to keep compatibility of agents between Spring Cloud Gateway and users' applications.
184+
185+
> [!NOTE]
186+
> By default, Azure Spring Apps prints the logs of the APM Java agent to `STDOUT`, which are mixed with Spring Cloud Gateway logs. You can check the version of APM agent used in logs. These logs can be queried in Log Analystics for troubleshooting.
187+
> Increase the cpu and memory of Spring Cloud Gateway to make APM agents work correctly.
188+
155189
## Next steps
156190

157191
- [How to Use Spring Cloud Gateway](how-to-use-enterprise-spring-cloud-gateway.md)

articles/spring-apps/toc.yml

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -128,10 +128,12 @@ items:
128128
href: how-to-enterprise-service-registry.md
129129
- name: Use API portal
130130
href: how-to-use-enterprise-api-portal.md
131-
- name: Use Spring Cloud Gateway
132-
href: how-to-use-enterprise-spring-cloud-gateway.md
133-
- name: Configure Spring Cloud Gateway
134-
href: how-to-configure-enterprise-spring-cloud-gateway.md
131+
- name: Spring Cloud Gateway
132+
items:
133+
- name: Manage Spring Cloud Gateway
134+
href: how-to-configure-enterprise-spring-cloud-gateway.md
135+
- name: Configure Routes
136+
href: how-to-use-enterprise-spring-cloud-gateway.md
135137
- name: Deploy
136138
items:
137139
- name: Set up a staging environment

0 commit comments

Comments
 (0)