From 052818041baa315c4f6e1d7f6b540b4fc788ebbc Mon Sep 17 00:00:00 2001 From: Daming Date: Mon, 3 Aug 2020 12:38:37 +0800 Subject: [PATCH] Fix typo (#5214) --- docs/en/setup/backend/backend-fetcher.md | 2 +- docs/en/setup/backend/configuration-vocabulary.md | 9 +++++---- .../java-agent/How-to-enable-kafka-reporter.md | 2 +- docs/en/setup/service-agent/java-agent/README.md | 7 ++++++- 4 files changed, 13 insertions(+), 7 deletions(-) diff --git a/docs/en/setup/backend/backend-fetcher.md b/docs/en/setup/backend/backend-fetcher.md index e821391be..cff6e27db 100644 --- a/docs/en/setup/backend/backend-fetcher.md +++ b/docs/en/setup/backend/backend-fetcher.md @@ -121,7 +121,7 @@ In cluster mode, all topics have the same number of partitions. Then we have to Kafka Fetcher allows to configure all the Kafka producers listed [here](http://kafka.apache.org/24/documentation.html#consumerconfigs) in property `kafkaConsumerConfig`. Such as: ```yaml kafka-fetcher: - selector: ${SW_KAFKA_FETCHER:-} + selector: ${SW_KAFKA_FETCHER:default} default: bootstrapServers: ${SW_KAFKA_FETCHER_SERVERS:localhost:9092} partitions: ${SW_KAFKA_FETCHER_PARTITIONS:3} diff --git a/docs/en/setup/backend/configuration-vocabulary.md b/docs/en/setup/backend/configuration-vocabulary.md index e217ab59b..c0ce0563d 100644 --- a/docs/en/setup/backend/configuration-vocabulary.md +++ b/docs/en/setup/backend/configuration-vocabulary.md @@ -182,10 +182,11 @@ core|default|role|Option values, `Mixed/Receiver/Aggregator`. **Receiver** mode | - | - | partitions | The number of partitions for the topic being created. | SW_KAFKA_FETCHER_PARTITIONS | 3 | | - | - | enableMeterSystem | To enable to fetch and handle [Meter System](backend-meter.md) data. | SW_KAFKA_FETCHER_ENABLE_METER_SYSTEM | false | - | - | replicationFactor | The replication factor for each partition in the topic being created. | SW_KAFKA_FETCHER_PARTITIONS_FACTOR | 2 | -| - | - | topicNameOfMetrics | Specifying Kafka topic name for Metrics data. | - | skywalking-metrics | -| - | - | topicNameOfProfiling | Specifying Kafka topic name for Profiling data. | - | skywalking-metrics | -| - | - | topicNameOfTracingSegments | Specifying Kafka topic name for Tracing data. | - | skywalking-metrics | -| - | - | topicNameOfManagements | Specifying Kafka topic name for service instance reporting and registering. | - | skywalking-metrics | +| - | - | topicNameOfMeters | Specifying Kafka topic name for Meter system data. | - | skywalking-meters | +| - | - | topicNameOfMetrics | Specifying Kafka topic name for JVM Metrics data. | - | skywalking-metrics | +| - | - | topicNameOfProfiling | Specifying Kafka topic name for Profiling data. | - | skywalking-profilings | +| - | - | topicNameOfTracingSegments | Specifying Kafka topic name for Tracing data. | - | skywalking-segments | +| - | - | topicNameOfManagements | Specifying Kafka topic name for service instance reporting and registering. | - | skywalking-managements | | query | graphql | - | GraphQL query implementation | - | | - | - | path | Root path of GraphQL query and mutation. | SW_QUERY_GRAPHQL_PATH | /graphql| | alarm | default | - | Read [alarm doc](backend-alarm.md) for more details. | - | diff --git a/docs/en/setup/service-agent/java-agent/How-to-enable-kafka-reporter.md b/docs/en/setup/service-agent/java-agent/How-to-enable-kafka-reporter.md index 162c4bcc6..c4b183e92 100644 --- a/docs/en/setup/service-agent/java-agent/How-to-enable-kafka-reporter.md +++ b/docs/en/setup/service-agent/java-agent/How-to-enable-kafka-reporter.md @@ -15,4 +15,4 @@ plugin.kafka.producer_config[delivery.timeout.ms]=12000 Kafka reporter plugin support to customize all configurations of listed in [here](http://kafka.apache.org/24/documentation.html#producerconfigs). -After you activated the Kafka reporter, you need to open [Kafka fetcher](../../backend/backend-fetcher.md#kafka-fetcher) at the OAP side. \ No newline at end of file +Before you activated the Kafka reporter, you have to make sure that [Kafka fetcher](../../backend/backend-fetcher.md#kafka-fetcher) has been opened in service. diff --git a/docs/en/setup/service-agent/java-agent/README.md b/docs/en/setup/service-agent/java-agent/README.md index 6a165199e..2aeab208d 100755 --- a/docs/en/setup/service-agent/java-agent/README.md +++ b/docs/en/setup/service-agent/java-agent/README.md @@ -135,7 +135,12 @@ property key | Description | Default | `correlation.element_max_number`|Max element count of the correlation context.|`3`| `correlation.value_max_length`|Max value length of correlation context element.|`128`| `plugin.kafka.bootstrap_servers`| A list of host/port pairs to use for establishing the initial connection to the Kafka cluster. | `localhost:9092` -`plugin.kafka.consumer_config`| Kafka producer configuration. | +`plugin.kafka.producer_config`| Kafka producer configuration. Read [producer configure](http://kafka.apache.org/24/documentation.html#producerconfigs) to get more details. Check [Kafka report doc](How-to-enable-kafka-reporter.md) for more details and examples. | | +`plugin.kafka.topic_meter` | Specify which Kafka topic name for Meter System data to report to. | `skywalking_meters` | +`plugin.kafka.topic_metrics` | Specify which Kafka topic name for JVM metrics data to report to. | `skywalking_metrics` | +`plugin.kafka.topic_segment` | Specify which Kafka topic name for traces data to report to. | `skywalking_segments` | +`plugin.kafka.topic_profilings` | Specify which Kafka topic name for Thread Profiling snapshot to report to. | `skywalking_profilings` | +`plugin.kafka.topic_management` | Specify which Kafka topic name for the register or heartbeat data of Service Instance to report to. | `skywalking_managements` | ## Optional Plugins Java agent plugins are all pluggable. Optional plugins could be provided in `optional-plugins` folder under agent or 3rd party repositories.