// Copyright 2025 Envoy Project Authors
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
// 
//     http://www.apache.org/licenses/LICENSE-2.0
// 
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

syntax = "proto3";

package envoy.extensions.tracers.opentelemetry.samplers.v3;

import "envoy/type/v3/percent.proto";

import "udpa/annotations/status.proto";

option java_package = "io.envoyproxy.envoy.extensions.tracers.opentelemetry.samplers.v3";
option java_outer_classname = "TraceIdRatioBasedSamplerProto";
option java_multiple_files = true;
option go_package = "github.com/envoyproxy/go-control-plane/envoy/extensions/tracers/opentelemetry/samplers/v3;samplersv3";
option (udpa.annotations.file_status).package_version_status = ACTIVE;

// [#protodoc-title: Trace Id Ratio Based Sampler config]
// Configuration for the "TraceIdRatioBased" Sampler extension.
// The sampler follows the "TraceIdRatioBased" implementation from the OpenTelemetry
// SDK specification.
//
// See:
// `TraceIdRatioBased sampler specification <https://opentelemetry.io/docs/specs/otel/trace/sdk/#traceidratiobased>`_
// [#extension: envoy.tracers.opentelemetry.samplers.trace_id_ratio_based]

message TraceIdRatioBasedSamplerConfig {
  // If the given trace_id falls into a given percentage of all possible
  // trace_id values, ShouldSample will return RECORD_AND_SAMPLE.
  // required
  // [#extension-category: envoy.tracers.opentelemetry.samplers]
  type.v3.FractionalPercent sampling_percentage = 1;
}
