wehub-resource-sync
91 lines
4.7 KiB
Markdown
91 lines
4.7 KiB
Markdown
---
|
|
id: spring_gateway
|
|
Title: Monitoring Spring Cloud Gateway
|
|
sidebar_label: Spring Cloud Gateway
|
|
keywords: [open source monitoring tool, open source Spring Cloud Gateway monitoring tool, monitoring Spring Cloud Gateway metrics]
|
|
---
|
|
|
|
> Collect and monitor the general performance metrics exposed by the SpringBoot actuator.
|
|
|
|
## Pre-monitoring operations
|
|
|
|
If you want to monitor information in `Spring Cloud Gateway` with this monitoring type, you need to integrate your `Spring Cloud Gateway` application and enable the SpringBoot Actuator.
|
|
|
|
**1、Add POM .XML dependencies:**
|
|
|
|
```xml
|
|
<dependency>
|
|
<groupId>org.springframework.boot</groupId>
|
|
<artifactId>spring-boot-starter-actuator</artifactId>
|
|
</dependency>
|
|
```
|
|
|
|
**2. Modify the YML configuration exposure metric interface:**
|
|
|
|
```yaml
|
|
management:
|
|
endpoint:
|
|
gateway:
|
|
enabled: true
|
|
env:
|
|
show-values: ALWAYS
|
|
endpoints:
|
|
web:
|
|
exposure:
|
|
include: "*"
|
|
```
|
|
|
|
### Configure parameters
|
|
|
|
| Parameter name | Parameter Help describes the |
|
|
|-----------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
|
| Monitor Host | THE MONITORED PEER IPV4, IPV6 OR DOMAIN NAME. Note ⚠️ that there are no protocol headers (eg: https://, http://). |
|
|
| Monitoring Name | A name that identifies this monitoring that needs to be unique. |
|
|
| Port | The default port provided by the database is 8080. |
|
|
| Enable HTTPS | Whether to access the website through HTTPS, please note that ⚠️ when HTTPS is enabled, the default port needs to be changed to 443 |
|
|
| The acquisition interval is | Monitor the periodic data acquisition interval, in seconds, and the minimum interval that can be set is 30 seconds |
|
|
| Whether to probe the | Whether to check the availability of the monitoring before adding a monitoring is successful, and the new modification operation will continue only if the probe is successful |
|
|
| Description Comment | For more information identifying and describing the remarks for this monitoring, users can remark the information here |
|
|
|
|
### Collect metrics
|
|
|
|
#### metric Collection: Health
|
|
|
|
| Metric Name | metric unit | Metrics help describe |
|
|
|-------------|-------------|--------------------------|
|
|
| status | None | Service health: UP, Down |
|
|
|
|
#### metric Collection: environment
|
|
|
|
| Metric Name | metric unit | Metrics help describe |
|
|
|-------------|-------------|-----------------------------------------------|
|
|
| profile | None | The application runs profile: prod, dev, test |
|
|
| port | None | Apply the exposed port |
|
|
| os | None | Run the operating system |
|
|
| os_arch | None | Run the operating system architecture |
|
|
| jdk_vendor | None | jdk vendor |
|
|
| jvm_version | None | jvm version |
|
|
|
|
#### metric Collection: threads
|
|
|
|
| Metric Name | metric unit | Metrics help describe |
|
|
|-------------|-------------|----------------------------------|
|
|
| state | None | Thread status |
|
|
| number | None | This thread state corresponds to number of threads |
|
|
|
|
#### metric Collection: memory_used
|
|
|
|
| Metric Name | metric unit | Metrics help describe |
|
|
|-------------|-------------|--------------------------------------|
|
|
| space | None | Memory space name |
|
|
| mem_used | MB | This space occupies a memory size of |
|
|
|
|
#### metric Collection: route_info
|
|
|
|
| Metric Name | metric unit | Metrics help describe |
|
|
|-------------|-------------|---------------------------------------|
|
|
| route_id | None | Route id |
|
|
| predicate | None | This is a routing matching rule |
|
|
| uri | None | This is a service resource identifier |
|
|
| order | None | The priority of this route |
|