From 0a6d21e8e101f1f507f1c171d677ebac765965e1 Mon Sep 17 00:00:00 2001 From: Lin Lin Date: Fri, 29 Dec 2023 10:27:43 -0800 Subject: [PATCH 1/2] Update CONFIGURATION.md --- CONFIGURATION.md | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/CONFIGURATION.md b/CONFIGURATION.md index 999742b8..0139bc00 100644 --- a/CONFIGURATION.md +++ b/CONFIGURATION.md @@ -107,18 +107,18 @@ SolarWindsAPM::Config[:transaction_settings] = [ Environment Variable | Config File Key | Description | Default -------------------- | --------------- | ----------- | ------- -`SW_APM_AUTO_CONFIGURE` | N/A | By default the library is configured to work out-of-the-box with all automatic instrumentation libraries enabled. Set this to false to custom initialize the library with configuration options for instrumentation, see [In-code Configuration](#in-code-configuration) for details. | true -`SW_APM_COLLECTOR` | N/A | Override the default collector endpoint to which the library connects and exports data. It should be defined using the format host:port. | apm.collector.cloud.solarwinds.com:443 +`SW_APM_AUTO_CONFIGURE` | N/A | By default the library is configured to work out-of-the-box with all automatic instrumentation libraries enabled. Set this to `false` to custom initialize the library with configuration options for instrumentation, see [In-code Configuration](#in-code-configuration) for details. | `true` +`SW_APM_COLLECTOR` | N/A | Override the default collector endpoint to which the library connects and exports data. It should be defined using the format host:port. | `apm.collector.cloud.solarwinds.com:443` `SW_APM_CONFIG_RUBY` | N/A | Override the default location for the configuration file. This can be an absolute or relative filename, or the directory under which the `solarwinds_apm_config.rb` file would be looked for. | None `SW_APM_DEBUG_LEVEL` | `:debug_level` | Set the library's logging level, valid values are 0 through 6 (least to most verbose). | 3 `SW_APM_EC2_METADATA_TIMEOUT` | `:ec2_metadata_timeout` | Timeout for AWS IMDS metadata retrieval in milliseconds. | 1000 -`SW_APM_ENABLED` | N/A | Enable/disable the library, setting `false` is an alternative to uninstalling `solarwinds_apm` since it will prevent the library from loading. | true +`SW_APM_ENABLED` | N/A | Enable/disable the library, setting `false` is an alternative to uninstalling `solarwinds_apm` since it will prevent the library from loading. | `true` `SW_APM_PROXY` | `:http_proxy` | Configure an HTTP proxy through which the library connects to the collector. | None `SW_APM_SERVICE_KEY` | `:service_key` | API token + service name combination, **required**. | -`SW_APM_TAG_SQL` | `:tag_sql` | Enable/disable injecting trace context into supported SQL statements. | false -`SW_APM_TRIGGER_TRACING_MODE` | `:trigger_tracing_mode` | | enable +`SW_APM_TAG_SQL` | `:tag_sql` | Enable/disable injecting trace context into supported SQL statements. Set to boolean true or (or string `true` in env var) to enable. | false +`SW_APM_TRIGGER_TRACING_MODE` | N/A | Enable/disable trigger tracing for the service. Setting to `disabled` turns off support. | `enabled` `SW_APM_TRUSTEDPATH` | N/A | The library uses the host system's default trusted CA certificates to verify the TLS connection to the collector. To override the default, define the trusted certificate path configuration option with an absolute path to a specific trusted certificate file in PEM format. | None -N/A | `:log_args` | Enable/disable the collection of URL query parameters, set to `false` to disable. | `true` +N/A | `:log_args` | Enable/disable the collection of URL query parameters, set to boolean false to disable. | true N/A | `:log_traceId` | Configure the insertion of trace context into application logs, setting `:traced` would include the available context fields such as trace_id, span_id into log messages. | `:never` N/A | `:tracing_mode` | Enable/disable the tracing mode for this service, setting `:disabled` would suppress all trace spans and metrics. | `:enabled` -N/A | `:transaction_settings` | Configure tracing mode per transaction, aka transaction filtering. | None \ No newline at end of file +N/A | `:transaction_settings` | Configure tracing mode per transaction, aka transaction filtering. | None From 3f8473b605a0225bd6ae81884bac7a53e62aab71 Mon Sep 17 00:00:00 2001 From: Lin Lin Date: Fri, 29 Dec 2023 10:39:09 -0800 Subject: [PATCH 2/2] Update CONFIGURATION.md --- CONFIGURATION.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/CONFIGURATION.md b/CONFIGURATION.md index 0139bc00..a3b83864 100644 --- a/CONFIGURATION.md +++ b/CONFIGURATION.md @@ -114,9 +114,9 @@ Environment Variable | Config File Key | Description | Default `SW_APM_EC2_METADATA_TIMEOUT` | `:ec2_metadata_timeout` | Timeout for AWS IMDS metadata retrieval in milliseconds. | 1000 `SW_APM_ENABLED` | N/A | Enable/disable the library, setting `false` is an alternative to uninstalling `solarwinds_apm` since it will prevent the library from loading. | `true` `SW_APM_PROXY` | `:http_proxy` | Configure an HTTP proxy through which the library connects to the collector. | None -`SW_APM_SERVICE_KEY` | `:service_key` | API token + service name combination, **required**. | +`SW_APM_SERVICE_KEY` | `:service_key` | API token and service name in the form of _token:service name_, **required**. | `SW_APM_TAG_SQL` | `:tag_sql` | Enable/disable injecting trace context into supported SQL statements. Set to boolean true or (or string `true` in env var) to enable. | false -`SW_APM_TRIGGER_TRACING_MODE` | N/A | Enable/disable trigger tracing for the service. Setting to `disabled` turns off support. | `enabled` +`SW_APM_TRIGGER_TRACING_MODE` | N/A | Enable/disable trigger tracing for the service. Setting to `disabled` may impact DEM visibility into the service. | `enabled` `SW_APM_TRUSTEDPATH` | N/A | The library uses the host system's default trusted CA certificates to verify the TLS connection to the collector. To override the default, define the trusted certificate path configuration option with an absolute path to a specific trusted certificate file in PEM format. | None N/A | `:log_args` | Enable/disable the collection of URL query parameters, set to boolean false to disable. | true N/A | `:log_traceId` | Configure the insertion of trace context into application logs, setting `:traced` would include the available context fields such as trace_id, span_id into log messages. | `:never`