模块 | 配置提供者 | 配置 | 值和解释 | 系统变量 | 默认值 |
core | default | role | 选项值:Mixed/Receiver/Aggregator.接收者模式 OAP 向代理开放服务,然后对结果进行分析和聚合,并将结果转发进行分布式聚合。聚合器模式 OAP 从混合器和接收器角色 OAP 节点接收数据,并执行第二级聚合。混合器既意味着接收器又意味着聚合器。 | SW_CORE_ROLE | Mixed |
- | - | restHost | RESTful服务的绑定IP。服务包括GraphQL查询和HTTP数据报告。 | SW_CORE_REST_HOST | 0.0.0.0 |
- | - | restPort | RESTful服务的绑定端口。 | SW_CORE_REST_PORT | 12800 |
- | - | restContextPath | RESTful 服务的 Web 上下文路径。 | SW_CORE_REST_CONTEXT_PATH | / |
- | - | restMaxThreads | RESTful服务的最大线程数。 | SW_CORE_REST_REST_MAX_THREADS | 200 |
- | - | restIdleTimeOut | RESTful 服务的连接器空闲超时(以毫秒为单位)。 | SW_CORE_REST_IDLE_TIMEOUT | 30000 |
- | - | restAcceptQueueSize | ServerSocketChannel RESTful 服务的积压。 | SW_CORE_REST_QUEUE_SIZE | 0 |
- | - | httpMaxRequestHeaderSize | 接受的最大请求标头大小。 | SW_CORE_HTTP_MAX_REQUEST_HEADER_SIZE | 8192 |
- | - | gRPCHost | gRPC服务的绑定IP,包括gRPC数据上报以及OAP节点之间的内部通信。 | SW_CORE_GRPC_HOST | 0.0.0.0 |
- | - | gRPCPort | gRPC服务的绑定端口。 | SW_CORE_GRPC_PORT | 11800 |
- | - | gRPCSslEnabled | 为 gRPC 服务激活 SSL。 | SW_CORE_GRPC_SSL_ENABLED | FALSE |
- | - | gRPCSslKeyPath | gRPC SSL 密钥的文件路径。 | SW_CORE_GRPC_SSL_KEY_PATH | - |
- | - | gRPCSslCertChainPath | gRPC SSL 证书链的文件路径。 | SW_CORE_GRPC_SSL_CERT_CHAIN_PATH | - |
- | - | gRPCSslTrustedCAPath | gRPC 可信 CA 的文件路径。 | SW_CORE_GRPC_SSL_TRUSTED_CA_PATH | - |
- | - | downsampling | 采样聚合的激活级别。 | Hour,Day | |
- | - | persistentPeriod | 持久定时器的执行周期(以秒为单位)。 | 25 | |
- | - | enableDataKeeperExecutor | TTL调度器的控制器。一旦禁用,TTL 将不起作用。 | SW_CORE_ENABLE_DATA_KEEPER_EXECUTOR | TRUE |
- | - | dataKeeperExecutePeriod | TTL调度程序的执行周期(以分钟为单位)。执行并不意味着删除数据。存储提供商(例如 ElasticSearch 存储)可以覆盖此设置。 | SW_CORE_DATA_KEEPER_EXECUTE_PERIOD | 5 |
- | - | recordDataTTL | 记录数据的生命周期(以天为单位)。记录数据包括轨迹、前 N 个样本记录和日志。最小值为 2。 | SW_CORE_RECORD_DATA_TTL | 3 |
- | - | metricsDataTTL | 指标数据的生命周期(以天为单位),包括元数据。我们建议设置metricsDataTTL >= recordDataTTL。最小值为 2。 | SW_CORE_METRICS_DATA_TTL | 7 |
- | - | l1FlushPeriod | L1聚合刷新到L2聚合的周期(以毫秒为单位)。 | SW_CORE_L1_AGGREGATION_FLUSH_PERIOD | 500 |
- | - | storageSessionTimeout | 会话时间阈值(以毫秒为单位)。默认值为 70000。 | SW_CORE_STORAGE_SESSION_TIMEOUT | 70000 |
- | - | persistentPeriod | 做数据持久化的时期。单位为秒。默认值为25s | SW_CORE_PERSISTENT_PERIOD | 25 |
- | - | enableDatabaseSession | 缓存指标数据 1 分钟以减少数据库查询,以及 OAP 集群是否在该分钟内发生变化。 | SW_CORE_ENABLE_DATABASE_SESSION | TRUE |
- | - | topNReportPeriod | top N采样器的执行周期(以分钟为单位),将采样数据保存到存储中。 | SW_CORE_TOPN_REPORT_PERIOD | 10 |
- | - | activeExtraModelColumns | 将实体名称(例如服务名称)附加到指标存储实体中。 | SW_CORE_ACTIVE_EXTRA_MODEL_COLUMNS | FALSE |
- | - | serviceNameMaxLength | 服务名称的最大长度限制。 | SW_SERVICE_NAME_MAX_LENGTH | 70 |
- | - | instanceNameMaxLength | 服务实例名称的最大长度限制。服务+实例名称的最大长度应小于200。 | SW_INSTANCE_NAME_MAX_LENGTH | 70 |
- | - | endpointNameMaxLength | 端点名称的最大长度限制。服务+端点名称的最大长度应小于240。 | SW_ENDPOINT_NAME_MAX_LENGTH | 150 |
- | - | searchableTracesTags | 定义一组可通过 GraphQL 搜索的跨度标签键。多个值用逗号分隔。 | SW_SEARCHABLE_TAG_KEYS | http.method,http.status_code,rpc.status_code,db.type,db.instance,mq.queue,mq.topic,mq.broker |
- | - | searchableLogsTags | 定义一组可通过 GraphQL 搜索的日志标签键。多个值用逗号分隔。 | SW_SEARCHABLE_LOGS_TAG_KEYS | level |
- | - | searchableAlarmTags | 定义一组可通过 GraphQL 搜索的警报标签键。多个值用逗号分隔。 | SW_SEARCHABLE_ALARM_TAG_KEYS | level |
- | - | autocompleteTagKeysQueryMaxSize | 自动完成选择的标签键的最大大小。 | SW_AUTOCOMPLETE_TAG_KEYS_QUERY_MAX_SIZE | 100 |
- | - | autocompleteTagValuesQueryMaxSize | 自动完成选择的标签值的最大大小。 | SW_AUTOCOMPLETE_TAG_VALUES_QUERY_MAX_SIZE | 100 |
- | - | gRPCThreadPoolSize | gRPC 服务器的池大小。 | SW_CORE_GRPC_THREAD_POOL_SIZE | CPU core * 4 |
- | - | gRPCThreadPoolQueueSize | gRPC 服务器的队列大小。 | SW_CORE_GRPC_POOL_QUEUE_SIZE | 10000 |
- | - | maxConcurrentCallsPerConnection | 每个传入连接允许的最大并发调用数。默认为无限制。 | SW_CORE_GRPC_MAX_CONCURRENT_CALL | - |
- | - | maxMessageSize | 设置服务器允许接收的最大消息大小。空默认4 MiB。 | SW_CORE_GRPC_MAX_MESSAGE_SIZE | 4M(based on Netty) |
- | - | remoteTimeout | 集群内部通信超时(以秒为单位)。 | - | 20 |
- | - | maxSizeOfNetworkAddressAlias | 在受监控的系统中检测到的网络地址的最大大小。 | - | 1_000_000 |
- | - | maxPageSizeOfQueryProfileSnapshot | OAP 查询中快照分析的最大大小。 | - | 500 |
- | - | maxSizeOfAnalyzeProfileSnapshot | OAP 分析的最大快照数。 | - | 12000 |
- | - | prepareThreads | 用于将指标数据准备到存储的线程数。 | SW_CORE_PREPARE_THREADS | 2 |
- | - | enableEndpointNameGroupingByOpenapi | 根据给定的 OpenAPI 定义自动对端点进行分组。 | SW_CORE_ENABLE_ENDPOINT_NAME_GROUPING_BY_OPAENAPI | TRUE |
- | - | maxDurationOfQueryEBPFProfilingData | 从数据库查询 eBPF 分析数据的最大持续时间(以秒为单位)。 | - | 30 |
- | - | maxThreadCountOfQueryEBPFProfilingData | 从数据库查询 eBPF 分析数据的最大线程数。 | - | System CPU core size |
cluster | standalone | - | Standalone不适合在单个节点上运行。没有可用的配置。 | - | - |
- | zookeeper | namespace | 命名空间以根路径表示,隔离了Zookeeper中的配置。 | SW_NAMESPACE | /, root path |
- | - | hostPort | Zookeeper集群的主机和端口。 | SW_CLUSTER_ZK_HOST_PORT | localhost:2181 |
- | - | baseSleepTimeMs | Zookeeper客户端两次重试之间的时间间隔(以毫秒为单位)。 | SW_CLUSTER_ZK_SLEEP_TIME | 1000 |
- | - | maxRetries | 最大重试时间。 | SW_CLUSTER_ZK_MAX_RETRIES | 3 |
- | - | enableACL | schema使用和打开 ACL expression。 | SW_ZK_ENABLE_ACL | FALSE |
- | - | schema | 授权的架构。 | SW_ZK_SCHEMA | digest |
- | - | expression | 授权的表达。 | SW_ZK_EXPRESSION | skywalking:skywalking |
- | - | internalComHost | 在Zookeeper中注册的主机名,用于OAP集群内部通信。 | SW_CLUSTER_INTERNAL_COM_HOST | - |
- | - | internalComPort | 在Zookeeper中注册的端口,用于OAP集群内部通信。 | SW_CLUSTER_INTERNAL_COM_PORT | -1 |
- | kubernetes | namespace | SkyWalking 在 k8s 中部署的命名空间。 | SW_CLUSTER_K8S_NAMESPACE | default |
- | - | labelSelector | 用于过滤 k8s 中 OAP 部署的标签。 | SW_CLUSTER_K8S_LABEL | app=collector,release=skywalking |
- | - | uidEnvName | 用于读取uid的环境变量名称。 | SW_CLUSTER_K8S_UID | SKYWALKING_COLLECTOR_UID |
- | consul | serviceName | SkyWalking 集群的服务名称。 | SW_SERVICE_NAME | SkyWalking_OAP_Cluster |
- | - | hostPort | Consul 集群的主机和端口。 | SW_CLUSTER_CONSUL_HOST_PORT | localhost:8500 |
- | - | aclToken | Consul 的 ACL 令牌。空字符串意味着without ALC token. | SW_CLUSTER_CONSUL_ACLTOKEN | - |
- | - | internalComHost | 在 Consul 中注册用于 OAP 集群内部通信的主机名。 | SW_CLUSTER_INTERNAL_COM_HOST | - |
- | - | internalComPort | 在 Consul 中注册用于 OAP 集群内部通信的端口。 | SW_CLUSTER_INTERNAL_COM_PORT | -1 |
- | etcd | serviceName | SkyWalking 集群的服务名称。 | SW_CLUSTER_ETCD_SERVICE_NAME | SkyWalking_OAP_Cluster |
- | - | endpoints | etcd 集群的主机和端口。 | SW_CLUSTER_ETCD_ENDPOINTS | localhost:2379 |
- | - | namespace | SkyWalking 集群的命名空间。 | SW_CLUSTER_ETCD_NAMESPACE | /skywalking |
- | - | authentication | 是否有认证。 | SW_CLUSTER_ETCD_AUTHENTICATION | FALSE |
- | - | user | etcd 验证用户名。 | SW_CLUSTER_ETCD_USER | |
- | - | password | etcd 验证密码。 | SW_CLUSTER_ETCD_PASSWORD | |
- | - | internalComHost | 在 etcd 中注册的主机名,用于 OAP 集群的内部通信。 | SW_CLUSTER_INTERNAL_COM_HOST | - |
- | - | internalComPort | 在 etcd 中注册的端口,用于 OAP 集群的内部通信。 | SW_CLUSTER_INTERNAL_COM_PORT | -1 |
- | Nacos | serviceName | SkyWalking 集群的服务名称。 | SW_SERVICE_NAME | SkyWalking_OAP_Cluster |
- | - | hostPort | Nacos 集群的主机和端口。 | SW_CLUSTER_NACOS_HOST_PORT | localhost:8848 |
- | - | namespace | SkyWalking 节点协调使用的命名空间。 | SW_CLUSTER_NACOS_NAMESPACE | public |
- | - | internalComHost | 在Nacos中注册的用于OAP集群内部通信的主机名。 | SW_CLUSTER_INTERNAL_COM_HOST | - |
- | - | internalComPort | 在Nacos中注册的端口,用于OAP集群内部通信。 | SW_CLUSTER_INTERNAL_COM_PORT | -1 |
- | - | username | Nacos 授权用户名。 | SW_CLUSTER_NACOS_USERNAME | - |
- | - | password | Nacos 授权密码。 | SW_CLUSTER_NACOS_PASSWORD | - |
- | - | accessKey | Nacos Auth accessKey。 | SW_CLUSTER_NACOS_ACCESSKEY | - |
- | - | secretKey | Nacos Auth 密钥。 | SW_CLUSTER_NACOS_SECRETKEY | - |
storage | elasticsearch | - | ElasticSearch(和 OpenSearch)存储实现。 | - | - |
- | - | namespace | SkyWalking 创建和使用的索引的前缀。 | SW_NAMESPACE | - |
- | - | clusterNodes | 用于客户端连接的 ElasticSearch 集群节点。 | SW_STORAGE_ES_CLUSTER_NODES | localhost |
- | - | protocol | HTTP 或者 HTTPs. | SW_STORAGE_ES_HTTP_PROTOCOL | HTTP |
- | - | connectTimeout | ElasticSearch 客户端的连接超时(以毫秒为单位)。 | SW_STORAGE_ES_CONNECT_TIMEOUT | 3000 |
- | - | socketTimeout | ElasticSearch 客户端的套接字超时(以毫秒为单位)。 | SW_STORAGE_ES_SOCKET_TIMEOUT | 30000 |
- | - | responseTimeout | ElasticSearch 客户端的响应超时(以毫秒为单位),0禁用超时。 | SW_STORAGE_ES_RESPONSE_TIMEOUT | 1500 |
- | - | numHttpClientThread | 底层 HTTP 客户端执行套接字 I/O 的线程数。如果该值 <= 0,则将使用可用处理器的数量。 | SW_STORAGE_ES_NUM_HTTP_CLIENT_THREAD | 0 |
- | - | user | ElasticSearch 集群的用户名。 | SW_ES_USER | - |
- | - | password | ElasticSearch集群的密码。 | SW_ES_PASSWORD | - |
- | - | trustStorePath | 信任 JKS 文件路径。仅当启用用户名和密码时才有效。 | SW_STORAGE_ES_SSL_JKS_PATH | - |
- | - | trustStorePass | 信任 JKS 文件密码。仅当启用用户名和密码时才有效。 | SW_STORAGE_ES_SSL_JKS_PASS | - |
- | - | secretsManagementFile | 属性格式的机密管理文件,包括用户名和密码,由第三方工具管理。能够在运行时更新它们。 | SW_ES_SECRETS_MANAGEMENT_FILE | - |
- | - | dayStep | 表示一分钟/小时/天索引中的天数。 | SW_STORAGE_DAY_STEP | 1 |
- | - | indexShardsNumber | 新索引的分片数量。 | SW_STORAGE_ES_INDEX_SHARDS_NUMBER | 1 |
- | - | indexReplicasNumber | 新索引的副本数。 | SW_STORAGE_ES_INDEX_REPLICAS_NUMBER | 0 |
- | - | superDatasetDayStep | 表示超大数据集记录索引中的天数。当值小于 0 时,默认值与 dayStep 相同。 | SW_SUPERDATASET_STORAGE_DAY_STEP | -1 |
- | - | superDatasetIndexShardsFactor | 超级数据集在代码中定义(例如跟踪段)。该因子为超级数据集提供更多分片:分片数量 = indexShardsNumber * superDatasetIndexShardsFactor。这个因素也会影响 Zipkin 和 Jaeger 痕迹。 | SW_STORAGE_ES_SUPER_DATASET_INDEX_SHARDS_FACTOR | 5 |
- | - | superDatasetIndexReplicasNumber | 表示超大数据集记录索引中的副本数。 | SW_STORAGE_ES_SUPER_DATASET_INDEX_REPLICAS_NUMBER | 0 |
- | - | indexTemplateOrder | 索引模板的顺序。 | SW_STORAGE_ES_INDEX_TEMPLATE_ORDER | 0 |
- | - | bulkActions | 批量执行记录数据的异步批量大小。 | SW_STORAGE_ES_BULK_ACTIONS | 5000 |
- | - | flushInterval | 冲洗周期(以秒为单位)。bulkActions达到与否并不重要。 INT(flushInterval * 2/3) 用于索引刷新周期。 | SW_STORAGE_ES_FLUSH_INTERVAL | 15 (index refresh period = 10) |
- | - | concurrentRequests | 允许执行的并发请求数。 | SW_STORAGE_ES_CONCURRENT_REQUESTS | 2 |
- | - | resultWindowMaxSize | OAP加载缓存时数据集的最大大小,例如网络别名。 | SW_STORAGE_ES_QUERY_MAX_WINDOW_SIZE | 10000 |
- | - | metadataQueryMaxSize | 每个查询的元数据的最大大小。 | SW_STORAGE_ES_QUERY_MAX_SIZE | 10000 |
- | - | scrollingBatchSize | metadataQueryMaxSize当或resultWindowMaxSize太大而无法在单个查询中检索时,每次迭代的元数据批量大小。 | SW_STORAGE_ES_SCROLLING_BATCH_SIZE | 5000 |
- | - | segmentQueryMaxSize | 每个查询的跟踪段的最大大小。 | SW_STORAGE_ES_QUERY_SEGMENT_SIZE | 200 |
- | - | profileTaskQueryMaxSize | 每个查询的配置文件任务的最大大小。 | SW_STORAGE_ES_QUERY_PROFILE_TASK_SIZE | 200 |
- | - | profileDataQueryScrollBatchSize | 查询分析数据的批量大小。 | SW_STORAGE_ES_QUERY_PROFILE_DATA_BATCH_SIZE | 100 |
- | - | advanced | ElasticSearch索引创建的所有设置。该值应为 JSON 格式。 | SW_STORAGE_ES_ADVANCED | - |
- | - | logicSharding | 将指标和记录索引分片为多物理索引,每个指标/计量聚合函数或记录一个索引模板。 | SW_STORAGE_ES_LOGIC_SHARDING | FALSE |
- | h2 | - | H2 存储仅设计用于短期(即1-2 小时)演示和运行。 | - | - |
- | - | driver | H2 JDBC 驱动程序。 | SW_STORAGE_H2_DRIVER | org.h2.jdbcx.JdbcDataSource |
- | - | url | H2 连接 URL。默认为 H2 内存模式。 | SW_STORAGE_H2_URL | jdbc:h2:mem:skywalking-oap-db |
- | - | user | H2数据库的用户名。 | SW_STORAGE_H2_USER | sa |
- | - | password | H2数据库的密码。 | - | - |
- | - | metadataQueryMaxSize | 每个查询的元数据的最大大小。 | SW_STORAGE_H2_QUERY_MAX_SIZE | 5000 |
- | - | maxSizeOfBatchSql | SQL执行的batch size的最大大小 | SW_STORAGE_MAX_SIZE_OF_BATCH_SQL | 100 |
- | - | asyncBatchPersistentPoolSize | 异步将数据刷新到数据库线程大小 | SW_STORAGE_ASYNC_BATCH_PERSISTENT_POOL_SIZE | 1 |
- | mysql | - | MySQL 存储。 MySQL JDBC 驱动程序不在 dist 中。请手动将其复制到oap-lib文件夹中。 | - | - |
- | - | properties | Hikari 连接池配置。 | - | Listed in the application.yaml. |
- | - | metadataQueryMaxSize | 每个查询的元数据的最大大小。 | SW_STORAGE_MYSQL_QUERY_MAX_SIZE | 5000 |
- | - | maxSizeOfArrayColumn | 一些实体(例如跟踪段)包括具有多个值的逻辑列。在MySQL中,我们使用多个物理列来承载值,例如将column_a的值[1,2,3,4,5]更改为column_a_0 = 1, column_a_1 = 2, column_a_2 = 3 , column_a_3 = 4, column_a_4 = 5。 | SW_STORAGE_MAX_SIZE_OF_ARRAY_COLUMN | 20 |
- | - | numOfSearchableValuesPerTag | 在跟踪段中,这包括具有多个标签的多个跨度。不同的跨度可以具有相同的标签键,例如多个HTTP退出跨度都具有它们自己的http.method标签。此配置设置同一标签键值的最大数量限制。 | SW_STORAGE_NUM_OF_SEARCHABLE_VALUES_PER_TAG | 2 |
- | - | maxSizeOfBatchSql | SQL执行的batch size的最大大小 | SW_STORAGE_MAX_SIZE_OF_BATCH_SQL | 2000 |
- | - | asyncBatchPersistentPoolSize | 异步将数据刷新到数据库线程大小 | SW_STORAGE_ASYNC_BATCH_PERSISTENT_POOL_SIZE | 4 |
- | postgresql | - | PostgreSQL 存储。 | - | - |
- | - | properties | Hikari 连接池配置。 | - | Listed in the application.yaml. |
- | - | metadataQueryMaxSize | 每个查询的元数据的最大大小。 | SW_STORAGE_MYSQL_QUERY_MAX_SIZE | 5000 |
- | - | maxSizeOfArrayColumn | 一些实体(例如跟踪段)包括具有多个值的逻辑列。在PostgreSQL中,我们使用多个物理列来承载值,例如将column_a的值[1,2,3,4,5]更改为column_a_0 = 1, column_a_1 = 2, column_a_2 = 3 , column_a_3 = 4, column_a_4 = 5 | SW_STORAGE_MAX_SIZE_OF_ARRAY_COLUMN | 20 |
- | - | numOfSearchableValuesPerTag | 在跟踪段中,这包括具有多个标签的多个跨度。不同的跨度可以具有相同的标签键,例如多个HTTP退出跨度都具有它们自己的http.method标签。此配置设置同一标签键值的最大数量限制。 | SW_STORAGE_NUM_OF_SEARCHABLE_VALUES_PER_TAG | 2 |
- | - | maxSizeOfBatchSql | SQL执行的batch size的最大大小 | SW_STORAGE_MAX_SIZE_OF_BATCH_SQL | 2000 |
- | - | asyncBatchPersistentPoolSize | 异步将数据刷新到数据库线程大小 | SW_STORAGE_ASYNC_BATCH_PERSISTENT_POOL_SIZE | 4 |
- | banyandb | - | BanyanDB 存储。 | - | - |
- | - | host | BanyanDB 的主机。 | SW_STORAGE_BANYANDB_HOST | 127.0.0.1 |
- | - | port | BanyanDB 的端口。 | SW_STORAGE_BANYANDB_PORT | 17912 |
- | - | maxBulkSize | 单个批量写入调用中写入实体的最大大小。 | SW_STORAGE_BANYANDB_MAX_BULK_SIZE | 5000 |
- | - | flushInterval | 冲洗间隔时间。以秒为时间单位。 | SW_STORAGE_BANYANDB_FLUSH_INTERVAL | 15 |
- | - | metricsShardsNumber | 度量/指标的分片数量。 | SW_STORAGE_BANYANDB_METRICS_SHARDS_NUMBER | 1 |
- | - | recordShardsNumber | 普通记录的分片数。 | SW_STORAGE_BANYANDB_RECORD_SHARDS_NUMBER | 1 |
- | - | superDatasetShardsFactor | 超级数据集记录的Shards Factor,即超级数据集的Shard编号为recordShardsNumber*superDatasetShardsFactor。 | SW_STORAGE_BANYANDB_SUPERDATASET_SHARDS_FACTOR | 2 |
- | - | concurrentWriteThreads | 用于批量写入的并发消费者线程。 | SW_STORAGE_BANYANDB_CONCURRENT_WRITE_THREADS | 15 |
- | - | profileTaskQueryMaxSize | 要获取的 ProfileTask 的最大大小。 | SW_STORAGE_BANYANDB_PROFILE_TASK_QUERY_MAX_SIZE | 200 |
agent-analyzer | default | Agent Analyzer. | SW_AGENT_ANALYZER | default | |
- | - | traceSamplingPolicySettingsFile | 采样策略包括sampling rate,the threshold of trace segment latency可以通过文件配置traceSamplingPolicySettingsFile。 | SW_TRACE_SAMPLING_POLICY_SETTINGS_FILE | trace-sampling-policy-settings.yml |
- | - | slowDBAccessThreshold | 慢速数据库访问阈值(以毫秒为单位)。 | SW_SLOW_DB_THRESHOLD | default:200,mongodb:100 |
- | - | forceSampleErrorSegment | 当采样机制被激活时,此配置对错误状态段进行采样并忽略采样率。 | SW_FORCE_SAMPLE_ERROR_SEGMENT | TRUE |
- | - | segmentStatusAnalysisStrategy | 根据跨度状态确定最终段状态。可用值为FROM_SPAN_STATUS、FROM_ENTRY_SPAN和FROM_FIRST_SPAN。FROM_SPAN_STATUS表示如果任何跨度处于错误状态,则该段状态将为错误。FROM_ENTRY_SPAN意味着段状态仅由条目跨度的状态确定。FROM_FIRST_SPAN意味着段状态仅由第一个跨度的状态确定。 | SW_SEGMENT_STATUS_ANALYSIS_STRATEGY | FROM_SPAN_STATUS |
- | - | noUpstreamRealAddressAgents | 列表中组件的退出跨度不会生成客户端实例关系指标,因为某些跟踪插件(例如 Nginx-LUA 和 Envoy)无法收集真实的对等 IP 地址。 | SW_NO_UPSTREAM_REAL_ADDRESS | 6000,9000 |
- | - | meterAnalyzerActiveFiles | 指示可以检测和分析哪些文件。多个文件用“,”分隔。 | SW_METER_ANALYZER_ACTIVE_FILES | |
receiver-sharing-server | default | 共享服务器提供了新的gRPC和restful服务器用于数据收集。 Ana 指定核心模块中的服务器仅用于内部通信。 | - | - | |
- | - | restHost | RESTful服务的绑定IP。服务包括GraphQL查询和HTTP数据报告。 | SW_RECEIVER_SHARING_REST_HOST | - |
- | - | restPort | RESTful服务的绑定端口。 | SW_RECEIVER_SHARING_REST_PORT | - |
- | - | restContextPath | RESTful 服务的 Web 上下文路径。 | SW_RECEIVER_SHARING_REST_CONTEXT_PATH | - |
- | - | restMaxThreads | RESTful服务的最大线程数。 | SW_RECEIVER_SHARING_REST_MAX_THREADS | 200 |
- | - | restIdleTimeOut | RESTful 服务的连接器空闲超时(以毫秒为单位)。 | SW_RECEIVER_SHARING_REST_IDLE_TIMEOUT | 30000 |
- | - | restAcceptQueueSize | ServerSocketChannel 积压的 RESTful 服务。 | SW_RECEIVER_SHARING_REST_QUEUE_SIZE | 0 |
- | - | httpMaxRequestHeaderSize | 接受的最大请求标头大小。 | SW_RECEIVER_SHARING_HTTP_MAX_REQUEST_HEADER_SIZE | 8192 |
- | - | gRPCHost | gRPC服务的绑定IP。服务包括gRPC数据报告和OAP节点之间的内部通信。 | SW_RECEIVER_GRPC_HOST | 0.0.0.0. Not Activated |
- | - | gRPCPort | gRPC服务的绑定端口。 | SW_RECEIVER_GRPC_PORT | Not Activated |
- | - | gRPCThreadPoolSize | gRPC 服务器的池大小。 | SW_RECEIVER_GRPC_THREAD_POOL_SIZE | CPU core * 4 |
- | - | gRPCThreadPoolQueueSize | gRPC 服务器的队列大小。 | SW_RECEIVER_GRPC_POOL_QUEUE_SIZE | 10000 |
- | - | gRPCSslEnabled | 为 gRPC 服务激活 SSL。 | SW_RECEIVER_GRPC_SSL_ENABLED | FALSE |
- | - | gRPCSslKeyPath | gRPC SSL 密钥的文件路径。 | SW_RECEIVER_GRPC_SSL_KEY_PATH | - |
- | - | gRPCSslCertChainPath | gRPC SSL 证书链的文件路径。 | SW_RECEIVER_GRPC_SSL_CERT_CHAIN_PATH | - |
- | - | maxConcurrentCallsPerConnection | 每个传入连接允许的最大并发调用数。默认为无限制。 | SW_RECEIVER_GRPC_MAX_CONCURRENT_CALL | - |
- | - | authentication | 用于身份验证的令牌文本。仅适用于 gRPC 连接。一旦设置完毕,客户端就需要使用相同的令牌。 | SW_AUTHENTICATION | - |
log-analyzer | default | Log Analyzer. | SW_LOG_ANALYZER | default | |
- | - | lalFiles | 要激活的 LAL 配置文件名(不带文件扩展名)。 | SW_LOG_LAL_FILES | default |
- | - | malFiles | 要激活的 MAL 配置文件名(不带文件扩展名)。 | SW_LOG_MAL_FILES | "" |
event-analyzer | default | Event Analyzer. | SW_EVENT_ANALYZER | default | |
receiver-register | default | gRPC和HTTPRestful服务提供服务、服务实例和端点注册。 | - | - | |
receiver-trace | default | 接受 SkyWalking 格式跟踪的 gRPC 和 HTTPRestful 服务。 | - | - | |
receiver-jvm | default | 接受 JVM 指标数据的 gRPC 服务。 | - | - | |
receiver-clr | default | 接受 .Net CLR 指标数据的 gRPC 服务。 | - | - | |
receiver-profile | default | 接受配置文件任务状态和快照报告器的 gRPC 服务。 | - | - | |
receiver-zabbix | default | TCP 接收器接受 Zabbix 格式指标。 | - | - | |
- | - | port | 导出的 TCP 端口。 Zabbix代理可以连接和传输数据。 | SW_RECEIVER_ZABBIX_PORT | 10051 |
- | - | host | 绑定到主机。 | SW_RECEIVER_ZABBIX_HOST | 0.0.0.0 |
- | - | activeFiles | 收到代理请求时启用配置。 | SW_RECEIVER_ZABBIX_ACTIVE_FILES | agent |
service-mesh | default | 接受来自入站网格探针的数据的 gRPC 服务。 | - | - | |
envoy-metric | default | Envoymetrics_service和ALS(access log service)均由该接收器支持。 OAL 脚本支持所有 GAUGE 类型指标。 | - | - | |
- | - | acceptMetricsService | 启动 Envoy Metrics Service 分析。 | SW_ENVOY_METRIC_SERVICE | TRUE |
- | - | alsHTTPAnalysis | 启动 Envoy HTTP 访问日志服务分析。 Value =k8s-mesh表示开始分析。 | SW_ENVOY_METRIC_ALS_HTTP_ANALYSIS | - |
- | - | alsTCPAnalysis | 启动 Envoy TCP 访问日志服务分析。 Value =k8s-mesh表示开始分析。 | SW_ENVOY_METRIC_ALS_TCP_ANALYSIS | - |
- | - | k8sServiceNameRule | k8sServiceNameRule允许您通过 Kubernetes 元数据自定义 ALS 中的服务名称。可用的变量是pod和service。例如,您可以${service.metadata.name}-${pod.metadata.labels.version}将版本号附加到服务名称中。请注意,当使用环境变量传递此配置时,请使用单引号( '') 以避免被 shell 求值。 | - | |
receiver-otel | default | 用于分析来自 OpenTelemetry 的指标数据的接收器。 | - | - | |
- | - | enabledHandlers | 为otel启用处理程序。 | SW_OTEL_RECEIVER_ENABLED_HANDLERS | - |
- | - | enabledOtelRules | 为 OC 处理程序启用指标规则。 | SW_OTEL_RECEIVER_ENABLED_OTEL_RULES | - |
receiver-zipkin | default | A receiver for Zipkin traces. | - | - | |
- | - | sampleRate | 采样率精度为1/10000,应在0到10000之间 | SW_ZIPKIN_SAMPLE_RATE | 10000 |
- | - | searchableTracesTags | 定义一组可搜索的跨度标签键。多个值用逗号分隔。 | SW_ZIPKIN_SEARCHABLE_TAG_KEYS | http.method |
- | - | enableHttpCollector | 启用 Http 收集器。 | SW_ZIPKIN_HTTP_COLLECTOR_ENABLED | TRUE |
- | - | restHost | RESTful服务的绑定IP。 | SW_RECEIVER_ZIPKIN_REST_HOST | 0.0.0.0 |
- | - | restPort | RESTful服务的绑定端口。 | SW_RECEIVER_ZIPKIN_REST_PORT | 9411 |
- | - | restContextPath | RESTful 服务的 Web 上下文路径。 | SW_RECEIVER_ZIPKIN_REST_CONTEXT_PATH | / |
- | - | restMaxThreads | RESTful服务的最大线程数。 | SW_RECEIVER_ZIPKIN_REST_MAX_THREADS | 200 |
- | - | restIdleTimeOut | RESTful 服务的连接器空闲超时(以毫秒为单位)。 | SW_RECEIVER_ZIPKIN_REST_IDLE_TIMEOUT | 30000 |
- | - | restAcceptQueueSize | 接受的最大请求标头大小。 | SW_RECEIVER_ZIPKIN_REST_QUEUE_SIZE | 0 |
- | - | enableKafkaCollector | 启用 Kafka 收集器。 | SW_ZIPKIN_KAFKA_COLLECTOR_ENABLED | FALSE |
- | - | kafkaBootstrapServers | Kafka 的收集服务器 | SW_ZIPKIN_KAFKA_SERVERS | localhost:9092 |
- | - | kafkaGroupId | kafka组Id | SW_ZIPKIN_KAFKA_GROUP_ID | zipkin |
- | - | kafkaTopic | kafka的topic | SW_ZIPKIN_KAFKA_TOPIC | zipkin |
- | - | kafkaConsumerConfig | Kafka 消费者配置,JSON 格式作为属性。如果它包含与上面相同的密钥,则会覆盖。 | SW_ZIPKIN_KAFKA_CONSUMER_CONFIG | “{"auto.offset.reset":"earliest","enable.auto.commit":true}” |
- | - | kafkaConsumers | 创建的消费者数量。 | SW_ZIPKIN_KAFKA_CONSUMERS | 1 |
- | - | kafkaHandlerThreadPoolSize | Kafka 消息处理程序执行器的池大小。 | SW_ZIPKIN_KAFKA_HANDLER_THREAD_POOL_SIZE | CPU core * 2 |
- | - | kafkaHandlerThreadPoolQueueSize | Kafka 消息处理程序执行器的队列大小。 | SW_ZIPKIN_KAFKA_HANDLER_THREAD_POOL_QUEUE_SIZE | 10000 |
prometheus-fetcher | default | Prometheus fetcher 从 Prometheus 端点读取指标,并将指标转换为 SkyWalking 本机格式以供 MAL 引擎使用。 | - | - | |
- | - | enabledRules | 启用的规则 | SW_PROMETHEUS_FETCHER_ENABLED_RULES | self |
- | - | maxConvertWorker | 最大的转换工作流 | SW_PROMETHEUS_FETCHER_NUM_CONVERT_WORKER | -1(by default, half the number of CPU core(s)) |
kafka-fetcher | default | 通过 Kafka 服务器读取 SkyWalking 的本机指标/日志/跟踪。 | - | - | |
- | - | bootstrapServers | 用于建立与 Kafka 集群的初始连接的主机/端口对列表。 | SW_KAFKA_FETCHER_SERVERS | localhost:9092 |
- | - | namespace | 命名空间的目的是在使用同一个Kafka集群时隔离多个OAP集群。如果您为 Kafka fetcher 设置命名空间,OAP 将为主题名称添加前缀。您还应该在agent.config.该属性名为plugin.kafka.namespace. | SW_NAMESPACE | - |
- | - | groupId | 标识该消费者所属的消费者组的唯一字符串。 | - | skywalking-consumer |
- | - | createTopicIfNotExist | 如果为 true,则会创建 Kafka 主题(如果尚不存在)。 | - | TRUE |
- | - | partitions | 正在创建的主题的分区数。 | SW_KAFKA_FETCHER_PARTITIONS | 3 |
- | - | consumers | 创建的消费者数量。 | SW_KAFKA_FETCHER_CONSUMERS | 1 |
- | - | enableNativeProtoLog | 允许获取和处理本机原型日志数据。 | SW_KAFKA_FETCHER_ENABLE_NATIVE_PROTO_LOG | TRUE |
- | - | enableNativeJsonLog | 启用获取和处理本机 json 日志数据。 | SW_KAFKA_FETCHER_ENABLE_NATIVE_JSON_LOG | TRUE |
- | - | replicationFactor | 正在创建的主题中每个分区的复制因子。 | SW_KAFKA_FETCHER_PARTITIONS_FACTOR | 2 |
- | - | kafkaHandlerThreadPoolSize | Kafka 消息处理程序执行器的池大小。 | SW_KAFKA_HANDLER_THREAD_POOL_SIZE | CPU core * 2 |
- | - | kafkaHandlerThreadPoolQueueSize | Kafka 消息处理程序执行器的队列大小。 | SW_KAFKA_HANDLER_THREAD_POOL_QUEUE_SIZE | 10000 |
- | - | topicNameOfMeters | 计量系统数据的 Kafka 主题名称。 | - | skywalking-meters |
- | - | topicNameOfMetrics | JVM 指标数据的 Kafka 主题名称。 | - | skywalking-metrics |
- | - | topicNameOfProfiling | 用于分析数据的 Kafka 主题名称。 | - | skywalking-profilings |
- | - | topicNameOfTracingSegments | 用于跟踪数据的 Kafka 主题名称。 | - | skywalking-segments |
- | - | topicNameOfManagements | 服务实例上报和注册的Kafka主题名称。 | - | skywalking-managements |
- | - | topicNameOfLogs | 本机原始日志数据的 Kafka 主题名称。 | - | skywalking-logs |
- | - | topicNameOfJsonLogs | 本机 json 日志数据的 Kafka 主题名称。 | - | skywalking-logs-json |
receiver-browser | default | 接受浏览器性能数据和错误日志的 gRPC 服务。 | - | - | - |
- | - | sampleRate | 接收跟踪的采样率。精确到 1/10000。 10000表示默认采样率为100%。 | SW_RECEIVER_BROWSER_SAMPLE_RATE | 10000 |
query | graphql | - | GraphQL 查询实现。 | - | |
- | - | enableLogTestTool | 启用日志测试 API 来测试 LAL。注意:此 API 评估 OAP 服务器上不受信任的代码。恶意脚本可能会造成重大损害(窃取密钥和机密、删除文件和目录、安装恶意软件等)。因此,请仅在您完全信任您的用户时启用此 API。 | SW_QUERY_GRAPHQL_ENABLE_LOG_TEST_TOOL | FALSE |
- | - | maxQueryComplexity | GraphQL 查询允许的最大复杂度,如果查询的数据字段总数超过定义的阈值,可用于中止查询。 | SW_QUERY_MAX_QUERY_COMPLEXITY | 1000 |
- | - | enableUpdateUITemplate | 允许用户添加、禁用和更新 UI 模板。 | SW_ENABLE_UPDATE_UI_TEMPLATE | FALSE |
- | - | enableOnDemandPodLog | 按需Pod日志:按需获取Pod日志,日志实时获取并显示,不以任何形式持久化。当用户想要做一些实验并监视日志并查看服务内部发生了什么时,这非常有用。注意:如果您在日志中打印机密,它们对 UI 也是可见的,因此为了安全起见,该功能默认处于禁用状态,请设置此配置以手动启用该功能。 | SW_ENABLE_ON_DEMAND_POD_LOG | FALSE |
query | graphql | - | GraphQL 查询实现。 | - | |
- | - | restHost | RESTful服务的绑定IP。 | SW_QUERY_ZIPKIN_REST_HOST | 0.0.0.0 |
- | - | restPort | RESTful服务的绑定端口。 | SW_QUERY_ZIPKIN_REST_PORT | 9412 |
- | - | restContextPath | RESTful 服务的 Web 上下文路径。 | SW_QUERY_ZIPKIN_REST_CONTEXT_PATH | zipkin |
- | - | restMaxThreads | RESTful服务的最大线程数。 | SW_QUERY_ZIPKIN_REST_MAX_THREADS | 200 |
- | - | restIdleTimeOut | RESTful 服务的连接器空闲超时(以毫秒为单位)。 | SW_QUERY_ZIPKIN_REST_IDLE_TIMEOUT | 30000 |
- | - | restAcceptQueueSize | 接受的最大请求标头大小。 | SW_QUERY_ZIPKIN_REST_QUEUE_SIZE | 0 |
- | - | lookback | 默认回顾跟踪和自动完成标签,1 天(以毫秒为单位) | SW_QUERY_ZIPKIN_LOOKBACK | 86400000 |
- | - | namesMaxAge | serviceNames、remoteServiceNames 和 spanNames 的 Cache-Control max-age(秒) | SW_QUERY_ZIPKIN_NAMES_MAX_AGE | 300 |
- | - | uiQueryLimit | 默认跟踪查询最大大小 | SW_QUERY_ZIPKIN_UI_QUERY_LIMIT | 10 |
- | - | uiDefaultLookback | 默认在 UI 上回顾搜索跟踪,15 分钟(以毫秒为单位) | SW_QUERY_ZIPKIN_UI_DEFAULT_LOOKBACK | 900000 |
alarm | default | - | - | ||
telemetry | - | - | - | ||
- | none | - | 没有操作实施。 | - | |
- | prometheus | host | Prometheus 服务器获取数据的绑定主机。 | SW_TELEMETRY_PROMETHEUS_HOST | 0.0.0.0 |
- | - | port | Prometheus服务器获取数据的绑定端口。 | SW_TELEMETRY_PROMETHEUS_PORT | 1234 |
configuration | - | - | - | ||
- | grpc | host | DCS服务器绑定主机名。 | SW_DCS_SERVER_HOST | - |
- | - | port | DCS服务器绑定端口。 | SW_DCS_SERVER_PORT | 80 |
- | - | clusterName | 从 DSC 服务器读取最新配置时的集群名称。 | SW_DCS_CLUSTER_NAME | SkyWalking |
- | - | period | OAP从DSC服务器读取数据的周期(以秒为单位)。 | SW_DCS_PERIOD | 20 |
- | apollo | apolloMeta | 阿波罗元数据 | SW_CONFIG_APOLLO | http://localhost:8080 |
- | - | apolloCluster | 阿波罗集群 | SW_CONFIG_APOLLO_CLUSTER | default |
- | - | apolloEnv | 阿波罗环境 | SW_CONFIG_APOLLO_ENV | - |
- | - | appId | 应用程序ID | SW_CONFIG_APOLLO_APP_ID | skywalking |
- | - | period | 数据同步的周期(以秒为单位)。 | SW_CONFIG_APOLLO_PERIOD | 60 |
- | zookeeper | namespace | 隔离 Zookeeper 中配置的命名空间(由根路径表示)。 | SW_CONFIG_ZK_NAMESPACE | /, root path |
- | - | hostPort | Zookeeper集群的主机和端口。 | SW_CONFIG_ZK_HOST_PORT | localhost:2181 |
- | - | baseSleepTimeMs | Zookeeper客户端两次重试之间的时间间隔(以毫秒为单位)。 | SW_CONFIG_ZK_BASE_SLEEP_TIME_MS | 1000 |
- | - | maxRetries | 最大重试时间。 | SW_CONFIG_ZK_MAX_RETRIES | 3 |
- | - | period | 数据同步的周期(以秒为单位)。 | SW_CONFIG_ZK_PERIOD | 60 |
- | etcd | endpoints | etcd 集群的主机和端口(如果有多个,则用逗号分隔)。 | SW_CONFIG_ETCD_ENDPOINTS | http://localhost:2379 |
- | - | namespace | SkyWalking 集群的命名空间。 | SW_CONFIG_ETCD_NAMESPACE | /skywalking |
- | - | authentication | 是否有认证。 | SW_CONFIG_ETCD_AUTHENTICATION | FALSE |
- | - | user | etcd 验证用户名。 | SW_CONFIG_ETCD_USER | |
- | - | password | etcd 验证密码。 | SW_CONFIG_ETCD_PASSWORD | |
- | - | period | 数据同步的周期(以秒为单位)。 | SW_CONFIG_ZK_PERIOD | 60 |
- | consul | hostPort | Consul 集群的主机和端口。 | SW_CONFIG_CONSUL_HOST_AND_PORTS | localhost:8500 |
- | - | aclToken | Consul 的 ACL 令牌。空字符串意味着without ACL token. | SW_CONFIG_CONSUL_ACL_TOKEN | - |
- | - | period | 数据同步的周期(以秒为单位)。 | SW_CONFIG_CONSUL_PERIOD | 60 |
- | k8s-configmap | namespace | 配置映射的部署命名空间。 | SW_CLUSTER_K8S_NAMESPACE | default |
- | - | labelSelector | 用于定位 configmap 的标签。 | SW_CLUSTER_K8S_LABEL | app=collector,release=skywalking |
- | - | period | 数据同步的周期(以秒为单位)。 | SW_CONFIG_ZK_PERIOD | 60 |
- | nacos | serverAddr | Nacos 服务器主机。 | SW_CONFIG_NACOS_SERVER_ADDR | 127.0.0.1 |
- | - | port | Nacos 服务器端口。 | SW_CONFIG_NACOS_SERVER_PORT | 8848 |
- | - | group | Nacos 配置命名空间。 | SW_CONFIG_NACOS_SERVER_NAMESPACE | - |
- | - | period | 数据同步的周期(以秒为单位)。 | SW_CONFIG_CONFIG_NACOS_PERIOD | 60 |
- | - | username | Nacos 授权用户名。 | SW_CONFIG_NACOS_USERNAME | - |
- | - | password | Nacos 授权密码。 | SW_CONFIG_NACOS_PASSWORD | - |
- | - | accessKey | Nacos Auth accessKey。 | SW_CONFIG_NACOS_ACCESSKEY | - |
- | - | secretKey | Nacos Auth 密钥。 | SW_CONFIG_NACOS_SECRETKEY | - |
exporter | grpc | targetHost | 用于接收导出数据的目标 gRPC 服务器的主机。 | SW_EXPORTER_GRPC_HOST | 127.0.0.1 |
- | - | targetPort | 用于接收导出数据的目标 gRPC 服务器的端口。 | SW_EXPORTER_GRPC_PORT | 9870 |
health-checker | default | checkIntervalSeconds | 检查OAP内部健康状态的周期(以秒为单位)。 | SW_HEALTH_CHECKER_INTERVAL_SECONDS | 5 |
configuration-discovery | default | disableMessageDigest | 如果为 true,代理每次都会收到最新配置,即使不进行任何更改。默认情况下,OAP 使用 SHA512 消息摘要机制来检测配置更改。 | SW_DISABLE_MESSAGE_DIGEST | FALSE |
receiver-event | default | gRPC services that handle events data. | - |
Skywalking配置文件详解
于 2024-05-24 11:56:21 首次发布