Skip to content

Commit

Permalink
Hide public documentation for App Analytics
Browse files Browse the repository at this point in the history
  • Loading branch information
marcotc committed Oct 25, 2023
1 parent f46d168 commit 3539e97
Show file tree
Hide file tree
Showing 92 changed files with 90 additions and 4 deletions.
1 change: 0 additions & 1 deletion docs/GettingStarted.md
Original file line number Diff line number Diff line change
Expand Up @@ -2061,7 +2061,6 @@ For example, if `tracing.sampling.default_rate` is configured by [Remote Configu
| `version` | `DD_VERSION` | `nil` | Your application version (e.g. `2.5`, `202003181415`, `1.3-alpha`, etc.) This value is set as a tag on all traces. |
| `telemetry.enabled` | `DD_INSTRUMENTATION_TELEMETRY_ENABLED` | `true` | Allows you to enable sending telemetry data to Datadog. Can be disabled, as documented [here](https://docs.datadoghq.com/tracing/configure_data_security/#telemetry-collection). |
| **Tracing** | | | |
| `tracing.analytics.enabled` | `DD_TRACE_ANALYTICS_ENABLED` | `nil` | Enables or disables trace analytics. See [Sampling](#sampling) for more details. |
| `tracing.contrib.peer_service_mapping` | `DD_TRACE_PEER_SERVICE_MAPPING` | `nil` | Defines remapping of `peer.service` tag across all instrumentation. Provide a list of `old_value1:new_value1, old_value2:new_value2, ...` |
| `tracing.contrib.global_default_service_name.enabled` | `DD_TRACE_REMOVE_INTEGRATION_SERVICE_NAMES_ENABLED` | `false` | Changes the default value for `service_name` to the application service name across all instrumentation |
| `tracing.distributed_tracing.propagation_extract_style` | `DD_TRACE_PROPAGATION_STYLE_EXTRACT` | `['Datadog','b3multi','b3']` | Distributed tracing propagation formats to extract. Overrides `DD_TRACE_PROPAGATION_STYLE`. See [Distributed Tracing](#distributed-tracing) for more details. |
Expand Down
1 change: 0 additions & 1 deletion lib/datadog/tracing/configuration/ext.rb
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,6 @@ module SpanAttributeSchema
ENV_PEER_SERVICE_MAPPING = 'DD_TRACE_PEER_SERVICE_MAPPING'
end

# @public_api
module Analytics
ENV_TRACE_ANALYTICS_ENABLED = 'DD_TRACE_ANALYTICS_ENABLED'
end
Expand Down
3 changes: 2 additions & 1 deletion lib/datadog/tracing/configuration/settings.rb
Original file line number Diff line number Diff line change
Expand Up @@ -23,10 +23,11 @@ def self.extended(base)
# @configure_with {Datadog::Tracing}
# @deprecated Use [Trace Retention and Ingestion](https://docs.datadoghq.com/tracing/trace_retention_and_ingestion/)
# controls.
# @public_api
# @!visibility private
settings :analytics do
# @default `DD_TRACE_ANALYTICS_ENABLED` environment variable, otherwise `nil`
# @return [Boolean,nil]
# @!visibility private
option :enabled do |o|
o.type :bool, nilable: true
o.env Tracing::Configuration::Ext::Analytics::ENV_TRACE_ANALYTICS_ENABLED
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@ class Settings < Contrib::Configuration::Settings
o.default true
end

# @!visibility private
option :analytics_enabled do |o|
o.type :bool
o.env Ext::ENV_ANALYTICS_ENABLED
Expand Down
1 change: 1 addition & 0 deletions lib/datadog/tracing/contrib/action_cable/ext.rb
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ module ActionCable
# @public_api Changing resource names, tag names, or environment variables creates breaking changes.
module Ext
ENV_ENABLED = 'DD_TRACE_ACTION_CABLE_ENABLED'
# @!visibility private
ENV_ANALYTICS_ENABLED = 'DD_TRACE_ACTION_CABLE_ANALYTICS_ENABLED'
ENV_ANALYTICS_SAMPLE_RATE = 'DD_TRACE_ACTION_CABLE_ANALYTICS_SAMPLE_RATE'
SPAN_ACTION = 'action_cable.action'
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@ class Settings < Contrib::Configuration::Settings
o.default true
end

# @!visibility private
option :analytics_enabled do |o|
o.type :bool
o.env Ext::ENV_ANALYTICS_ENABLED
Expand Down
1 change: 1 addition & 0 deletions lib/datadog/tracing/contrib/action_mailer/ext.rb
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ module ActionMailer
# @public_api Changing resource names, tag names, or environment variables creates breaking changes.
module Ext
ENV_ENABLED = 'DD_TRACE_ACTION_MAILER_ENABLED'
# @!visibility private
ENV_ANALYTICS_ENABLED = 'DD_TRACE_ACTION_MAILER_ANALYTICS_ENABLED'
ENV_ANALYTICS_SAMPLE_RATE = 'DD_TRACE_ACTION_MAILER_ANALYTICS_SAMPLE_RATE'
SPAN_PROCESS = 'action_mailer.process'
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@ class Settings < Contrib::Configuration::Settings
o.default true
end

# @!visibility private
option :analytics_enabled do |o|
o.type :bool, nilable: true
o.env Ext::ENV_ANALYTICS_ENABLED
Expand Down
1 change: 1 addition & 0 deletions lib/datadog/tracing/contrib/action_pack/ext.rb
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ module ActionPack
# @public_api Changing resource names, tag names, or environment variables creates breaking changes.
module Ext
ENV_ENABLED = 'DD_TRACE_ACTION_PACK_ENABLED'
# @!visibility private
ENV_ANALYTICS_ENABLED = 'DD_TRACE_ACTION_PACK_ANALYTICS_ENABLED'
ENV_ANALYTICS_SAMPLE_RATE = 'DD_TRACE_ACTION_PACK_ANALYTICS_SAMPLE_RATE'
SPAN_ACTION_CONTROLLER = 'rails.action_controller'
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@ class Settings < Contrib::Configuration::Settings
o.default true
end

# @!visibility private
option :analytics_enabled do |o|
o.type :bool
o.env Ext::ENV_ANALYTICS_ENABLED
Expand Down
1 change: 1 addition & 0 deletions lib/datadog/tracing/contrib/action_view/ext.rb
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ module ActionView
# @public_api Changing resource names, tag names, or environment variables creates breaking changes.
module Ext
ENV_ENABLED = 'DD_TRACE_ACTION_VIEW_ENABLED'
# @!visibility private
ENV_ANALYTICS_ENABLED = 'DD_TRACE_ACTION_VIEW_ANALYTICS_ENABLED'
ENV_ANALYTICS_SAMPLE_RATE = 'DD_TRACE_ACTION_VIEW_ANALYTICS_SAMPLE_RATE'
SPAN_RENDER_PARTIAL = 'rails.render_partial'
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@ class Settings < Contrib::Configuration::Settings
o.default true
end

# @!visibility private
option :analytics_enabled do |o|
o.type :bool
o.env Ext::ENV_ANALYTICS_ENABLED
Expand Down
1 change: 1 addition & 0 deletions lib/datadog/tracing/contrib/active_job/ext.rb
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ module ActiveJob
# @public_api Changing resource names, tag names, or environment variables creates breaking changes.
module Ext
ENV_ENABLED = 'DD_TRACE_ACTIVE_JOB_ENABLED'
# @!visibility private
ENV_ANALYTICS_ENABLED = 'DD_TRACE_ACTIVE_JOB_ANALYTICS_ENABLED'
ENV_ANALYTICS_SAMPLE_RATE = 'DD_TRACE_ACTIVE_JOB_ANALYTICS_SAMPLE_RATE'

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@ class Settings < Contrib::Configuration::Settings
o.default true
end

# @!visibility private
option :analytics_enabled do |o|
o.type :bool
o.env Ext::ENV_ANALYTICS_ENABLED
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ module ActiveModelSerializers
# @public_api Changing resource names, tag names, or environment variables creates breaking changes.
module Ext
ENV_ENABLED = 'DD_TRACE_ACTIVE_MODEL_SERIALIZERS_ENABLED'
# @!visibility private
ENV_ANALYTICS_ENABLED = 'DD_TRACE_ACTIVE_MODEL_SERIALIZERS_ANALYTICS_ENABLED'
ENV_ANALYTICS_SAMPLE_RATE = 'DD_TRACE_ACTIVE_MODEL_SERIALIZERS_ANALYTICS_SAMPLE_RATE'
SPAN_RENDER = 'active_model_serializers.render'
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@ class Settings < Contrib::Configuration::Settings
o.default true
end

# @!visibility private
option :analytics_enabled do |o|
o.type :bool
o.env Ext::ENV_ANALYTICS_ENABLED
Expand Down
1 change: 1 addition & 0 deletions lib/datadog/tracing/contrib/active_record/ext.rb
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ module ActiveRecord
# @public_api Changing resource names, tag names, or environment variables creates breaking changes.
module Ext
ENV_ENABLED = 'DD_TRACE_ACTIVE_RECORD_ENABLED'
# @!visibility private
ENV_ANALYTICS_ENABLED = 'DD_TRACE_ACTIVE_RECORD_ANALYTICS_ENABLED'
ENV_ANALYTICS_SAMPLE_RATE = 'DD_TRACE_ACTIVE_RECORD_ANALYTICS_SAMPLE_RATE'
SERVICE_NAME = 'active_record'
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@ class Settings < Contrib::Configuration::Settings
o.default true
end

# @!visibility private
option :analytics_enabled do |o|
o.type :bool
o.env Ext::ENV_ANALYTICS_ENABLED
Expand Down
1 change: 1 addition & 0 deletions lib/datadog/tracing/contrib/active_support/ext.rb
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ module ActiveSupport
# @public_api Changing resource names, tag names, or environment variables creates breaking changes.
module Ext
ENV_ENABLED = 'DD_TRACE_ACTIVE_SUPPORT_ENABLED'
# @!visibility private
ENV_ANALYTICS_ENABLED = 'DD_TRACE_ACTIVE_SUPPORT_ANALYTICS_ENABLED'
ENV_ANALYTICS_SAMPLE_RATE = 'DD_TRACE_ACTIVE_SUPPORT_ANALYTICS_SAMPLE_RATE'
QUANTIZE_CACHE_MAX_KEY_SIZE = 300
Expand Down
1 change: 0 additions & 1 deletion lib/datadog/tracing/contrib/analytics.rb
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,6 @@ module Datadog
module Tracing
module Contrib
# Defines analytics behavior for integrations
# @public_api
module Analytics
module_function

Expand Down
1 change: 1 addition & 0 deletions lib/datadog/tracing/contrib/aws/configuration/settings.rb
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@ class Settings < Contrib::Configuration::Settings
o.default true
end

# @!visibility private
option :analytics_enabled do |o|
o.type :bool
o.env Ext::ENV_ANALYTICS_ENABLED
Expand Down
1 change: 1 addition & 0 deletions lib/datadog/tracing/contrib/aws/ext.rb
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ module Ext
ENV_ENABLED = 'DD_TRACE_AWS_ENABLED'
ENV_SERVICE_NAME = 'DD_TRACE_AWS_SERVICE_NAME'
ENV_PEER_SERVICE = 'DD_TRACE_AWS_PEER_SERVICE'
# @!visibility private
ENV_ANALYTICS_ENABLED = 'DD_TRACE_AWS_ANALYTICS_ENABLED'
ENV_ANALYTICS_SAMPLE_RATE = 'DD_TRACE_AWS_ANALYTICS_SAMPLE_RATE'
DEFAULT_PEER_SERVICE_NAME = 'aws'
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@ class Settings < Contrib::Configuration::Settings
o.default true
end

# @!visibility private
option :analytics_enabled do |o|
o.type :bool
o.env Ext::ENV_ANALYTICS_ENABLED
Expand Down
1 change: 1 addition & 0 deletions lib/datadog/tracing/contrib/dalli/ext.rb
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@ module Ext
# DEV: If add support for the `memcached` gem (not popular as of 2023), we'll have issues with span naming
# DEV: conflicts.
ENV_ENABLED = 'DD_TRACE_DALLI_ENABLED'
# @!visibility private
ENV_ANALYTICS_ENABLED = 'DD_TRACE_DALLI_ANALYTICS_ENABLED'
ENV_ANALYTICS_SAMPLE_RATE = 'DD_TRACE_DALLI_ANALYTICS_SAMPLE_RATE'
# DEV: This is named `*_MEMCACHED_*` because the spans it refer to are `memcached.*` and this variable
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@ class Settings < Contrib::Configuration::Settings
o.default true
end

# @!visibility private
option :analytics_enabled do |o|
o.type :bool
o.env Ext::ENV_ANALYTICS_ENABLED
Expand Down
1 change: 1 addition & 0 deletions lib/datadog/tracing/contrib/delayed_job/ext.rb
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ module DelayedJob
# @public_api Changing resource names, tag names, or environment variables creates breaking changes.
module Ext
ENV_ENABLED = 'DD_TRACE_DELAYED_JOB_ENABLED'
# @!visibility private
ENV_ANALYTICS_ENABLED = 'DD_TRACE_DELAYED_JOB_ANALYTICS_ENABLED'
ENV_ANALYTICS_SAMPLE_RATE = 'DD_TRACE_DELAYED_JOB_ANALYTICS_SAMPLE_RATE'
SPAN_JOB = 'delayed_job'
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@ class Settings < Contrib::Configuration::Settings
o.default true
end

# @!visibility private
option :analytics_enabled do |o|
o.type :bool
o.env Ext::ENV_ANALYTICS_ENABLED
Expand Down
1 change: 1 addition & 0 deletions lib/datadog/tracing/contrib/elasticsearch/ext.rb
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ module Ext
ENV_ENABLED = 'DD_TRACE_ELASTICSEARCH_ENABLED'
ENV_SERVICE_NAME = 'DD_TRACE_ELASTICSEARCH_SERVICE_NAME'
ENV_PEER_SERVICE = 'DD_TRACE_ELASTICSEARCH_PEER_SERVICE'
# @!visibility private
ENV_ANALYTICS_ENABLED = 'DD_TRACE_ELASTICSEARCH_ANALYTICS_ENABLED'
ENV_ANALYTICS_SAMPLE_RATE = 'DD_TRACE_ELASTICSEARCH_ANALYTICS_SAMPLE_RATE'
DEFAULT_PEER_SERVICE_NAME = 'elasticsearch'
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@ class Settings < Contrib::Configuration::Settings
o.default true
end

# @!visibility private
option :analytics_enabled do |o|
o.type :bool
o.env Ext::ENV_ANALYTICS_ENABLED
Expand Down
1 change: 1 addition & 0 deletions lib/datadog/tracing/contrib/ethon/ext.rb
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@ module Ext
ENV_SERVICE_NAME = 'DD_TRACE_ETHON_SERVICE_NAME'
ENV_PEER_SERVICE = 'DD_TRACE_ETHON_PEER_SERVICE'

# @!visibility private
ENV_ANALYTICS_ENABLED = 'DD_TRACE_ETHON_ANALYTICS_ENABLED'
ENV_ANALYTICS_SAMPLE_RATE = 'DD_TRACE_ETHON_ANALYTICS_SAMPLE_RATE'
DEFAULT_PEER_SERVICE_NAME = 'ethon'
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@ class Settings < Contrib::Configuration::Settings
o.default true
end

# @!visibility private
option :analytics_enabled do |o|
o.type :bool
o.env Ext::ENV_ANALYTICS_ENABLED
Expand Down
1 change: 1 addition & 0 deletions lib/datadog/tracing/contrib/excon/ext.rb
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@ module Ext
ENV_SERVICE_NAME = 'DD_TRACE_EXCON_SERVICE_NAME'
ENV_PEER_SERVICE = 'DD_TRACE_EXCON_PEER_SERVICE'

# @!visibility private
ENV_ANALYTICS_ENABLED = 'DD_TRACE_EXCON_ANALYTICS_ENABLED'
ENV_ANALYTICS_SAMPLE_RATE = 'DD_TRACE_EXCON_ANALYTICS_SAMPLE_RATE'
DEFAULT_PEER_SERVICE_NAME = 'excon'
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,7 @@ class Settings < Contrib::Configuration::Settings
o.default true
end

# @!visibility private
option :analytics_enabled do |o|
o.type :bool
o.env Ext::ENV_ANALYTICS_ENABLED
Expand Down
1 change: 1 addition & 0 deletions lib/datadog/tracing/contrib/faraday/ext.rb
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@ module Ext
ENV_SERVICE_NAME = 'DD_TRACE_FARADAY_SERVICE_NAME'
ENV_PEER_SERVICE = 'DD_TRACE_FARADAY_PEER_SERVICE'

# @!visibility private
ENV_ANALYTICS_ENABLED = 'DD_TRACE_FARADAY_ANALYTICS_ENABLED'
ENV_ANALYTICS_SAMPLE_RATE = 'DD_TRACE_FARADAY_ANALYTICS_SAMPLE_RATE'
DEFAULT_PEER_SERVICE_NAME = 'faraday'
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@ class Settings < Contrib::Configuration::Settings
o.default true
end

# @!visibility private
option :analytics_enabled do |o|
o.type :bool, nilable: true
o.env Ext::ENV_ANALYTICS_ENABLED
Expand Down
1 change: 1 addition & 0 deletions lib/datadog/tracing/contrib/grape/ext.rb
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ module Grape
# @public_api Changing resource names, tag names, or environment variables creates breaking changes.
module Ext
ENV_ENABLED = 'DD_TRACE_GRAPE_ENABLED'
# @!visibility private
ENV_ANALYTICS_ENABLED = 'DD_TRACE_GRAPE_ANALYTICS_ENABLED'
ENV_ANALYTICS_SAMPLE_RATE = 'DD_TRACE_GRAPE_ANALYTICS_SAMPLE_RATE'
SPAN_ENDPOINT_RENDER = 'grape.endpoint_render'
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@ class Settings < Contrib::Configuration::Settings
o.default true
end

# @!visibility private
option :analytics_enabled do |o|
o.type :bool, nilable: true
o.env Ext::ENV_ANALYTICS_ENABLED
Expand Down
1 change: 1 addition & 0 deletions lib/datadog/tracing/contrib/graphql/ext.rb
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ module GraphQL
# @public_api Changing resource names, tag names, or environment variables creates breaking changes.
module Ext
ENV_ENABLED = 'DD_TRACE_GRAPHQL_ENABLED'
# @!visibility private
ENV_ANALYTICS_ENABLED = 'DD_TRACE_GRAPHQL_ANALYTICS_ENABLED'
ENV_ANALYTICS_SAMPLE_RATE = 'DD_TRACE_GRAPHQL_ANALYTICS_SAMPLE_RATE'
SERVICE_NAME = 'graphql'
Expand Down
1 change: 1 addition & 0 deletions lib/datadog/tracing/contrib/grpc/configuration/settings.rb
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@ class Settings < Contrib::Configuration::Settings
o.default true
end

# @!visibility private
option :analytics_enabled do |o|
o.type :bool
o.env Ext::ENV_ANALYTICS_ENABLED
Expand Down
1 change: 1 addition & 0 deletions lib/datadog/tracing/contrib/grpc/ext.rb
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ module Ext
ENV_ENABLED = 'DD_TRACE_GRPC_ENABLED'
ENV_SERVICE_NAME = 'DD_TRACE_GRPC_SERVICE_NAME'
ENV_PEER_SERVICE = 'DD_TRACE_GRPC_PEER_SERVICE'
# @!visibility private
ENV_ANALYTICS_ENABLED = 'DD_TRACE_GRPC_ANALYTICS_ENABLED'
ENV_ANALYTICS_SAMPLE_RATE = 'DD_TRACE_GRPC_ANALYTICS_SAMPLE_RATE'
DEFAULT_PEER_SERVICE_NAME = 'grpc'
Expand Down
1 change: 1 addition & 0 deletions lib/datadog/tracing/contrib/http/configuration/settings.rb
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@ class Settings < Contrib::Configuration::Settings
o.default true
end

# @!visibility private
option :analytics_enabled do |o|
o.type :bool
o.env Ext::ENV_ANALYTICS_ENABLED
Expand Down
1 change: 1 addition & 0 deletions lib/datadog/tracing/contrib/http/ext.rb
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ module Ext
ENV_ENABLED = 'DD_TRACE_HTTP_ENABLED'
ENV_SERVICE_NAME = 'DD_TRACE_NET_HTTP_SERVICE_NAME'
ENV_PEER_SERVICE = 'DD_TRACE_NET_HTTP_PEER_SERVICE'
# @!visibility private
ENV_ANALYTICS_ENABLED = 'DD_TRACE_HTTP_ANALYTICS_ENABLED'
ENV_ANALYTICS_SAMPLE_RATE = 'DD_TRACE_HTTP_ANALYTICS_SAMPLE_RATE'
ENV_ERROR_STATUS_CODES = 'DD_TRACE_HTTP_ERROR_STATUS_CODES'
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@ class Settings < Contrib::Configuration::Settings
o.default true
end

# @!visibility private
option :analytics_enabled do |o|
o.type :bool
o.env Ext::ENV_ANALYTICS_ENABLED
Expand Down
Loading

0 comments on commit 3539e97

Please sign in to comment.