dynamic-config.md 4.2 KB
Newer Older
1
# Dynamic Configuration
W
Wing 已提交
2
SkyWalking Configurations are mostly set through `application.yml` and OS system environment variables.
3

4 5 6
At the same time, some of them support dynamic settings from an upstream management system.

Currently, SkyWalking supports two types of dynamic configurations: Single and Group.
7

8 9
This feature depends on upstream service, so it is **DISABLED** by default.

10 11
```yaml
configuration:
12
  selector: ${SW_CONFIGURATION:none}
13
  none:
14 15 16 17 18
  grpc:
    host: ${SW_DCS_SERVER_HOST:""}
    port: ${SW_DCS_SERVER_PORT:80}
    clusterName: ${SW_DCS_CLUSTER_NAME:SkyWalking}
    period: ${SW_DCS_PERIOD:20}
19
  # ... other implementations
20
```
21 22
## Single Configuration
Single Configuration is a config key that corresponds to a specific config value. The logic structure is:
23
```
X
xiao ru xing 已提交
24
{configKey}:{configValue}
25
```
26
For example:
A
Alan Lau 已提交
27
```
28
{agent-analyzer.default.slowDBAccessThreshold}:{default:200,mongodb:50}
29
```
30
Supported configurations are as follows:
31

32 33
| Config Key | Value Description | Value Format Example |
|:----:|:----:|:----:|
34
|agent-analyzer.default.slowDBAccessThreshold| Thresholds of slow Database statement. Overrides `agent-analyzer/default/slowDBAccessThreshold` of `application.yml`. | default:200,mongodb:50|
35 36 37 38 39
|agent-analyzer.default.uninstrumentedGateways| The uninstrumented gateways. Overrides `gateways.yml`. | Same as [`gateways.yml`](uninstrumented-gateways.md#configuration-format). |
|alarm.default.alarm-settings| The alarm settings. Overrides `alarm-settings.yml`. | Same as [`alarm-settings.yml`](backend-alarm.md). |
|core.default.apdexThreshold| The apdex threshold settings. Overrides `service-apdex-threshold.yml`. | Same as [`service-apdex-threshold.yml`](apdex-threshold.md). |
|core.default.endpoint-name-grouping| The endpoint name grouping setting. Overrides `endpoint-name-grouping.yml`. | Same as [`endpoint-name-grouping.yml`](endpoint-grouping-rules.md). |
|core.default.log4j-xml| The log4j xml configuration. Overrides `log4j2.xml`. | Same as [`log4j2.xml`](dynamical-logging.md). |
40
|agent-analyzer.default.traceSamplingPolicy| The sampling policy for default and service dimension, override `trace-sampling-policy-settings.yml`. | same as [`trace-sampling-policy-settings.yml`](trace-sampling.md) | 
41
|configuration-discovery.default.agentConfigurations| The ConfigurationDiscovery settings. | See [`configuration-discovery.md`](https://github.com/apache/skywalking-java/blob/20fb8c81b3da76ba6628d34c12d23d3d45c973ef/docs/en/setup/service-agent/java-agent/configuration-discovery.md). |
42

43
## Group Configuration
44
Group Configuration is a config key corresponding to a group sub config item. A sub config item is a key-value pair. The logic structure is:
45
```
46 47 48 49 50 51 52 53 54 55 56
{configKey}: |{subItemkey1}:{subItemValue1}
             |{subItemkey2}:{subItemValue2}
             |{subItemkey3}:{subItemValue3}
             ...      
```
For example:
```
{core.default.endpoint-name-grouping-openapi}:|{customerAPI-v1}:{value of customerAPI-v1}
                                              |{productAPI-v1}:{value of productAPI-v1}
                                              |{productAPI-v2}:{value of productAPI-v2}
                                              
57
```
58
Supported configurations are as follows:
59

60 61 62 63
| Config Key | SubItem Key Description |  Value Description | Value Format Example |
|:----:|:----:|:----:|:----:|
|core.default.endpoint-name-grouping-openapi|The serviceName relevant to openAPI definition file. eg. `serviceA`. If the serviceName relevant to multiple files should add subItems for each files, and each subItem key should split serviceName and fileName with `.` eg. `serviceA.API-file1`,`serviceA.API-file2` |The openAPI definitions file contents(yaml format) for create endpoint name grouping rules.|Same as [`productAPI-v2.yaml`](endpoint-grouping-rules.md)|

64 65 66 67 68 69
## Dynamic Configuration Implementations
- [Dynamic Configuration Service, DCS](./dynamic-config-service.md)
- [Zookeeper Implementation](./dynamic-config-zookeeper.md)
- [Etcd Implementation](./dynamic-config-etcd.md)
- [Consul Implementation](./dynamic-config-consul.md)
- [Apollo Implementation](./dynamic-config-apollo.md)
X
xiao ru xing 已提交
70
- [Kubernetes Configmap Implementation](./dynamic-config-configmap.md)
71
- [Nacos Implementation](./dynamic-config-nacos.md)