ZipkinPluginConfig

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/ZipkinPluginConfig",
  "title": "ZipkinPluginConfig",
  "x-speakeasy-entity": "PluginZipkin",
  "properties": {
    "config": {
      "type": "object",
      "properties": {
        "connect_timeout": {
          "description": "An integer representing a timeout in milliseconds. Must be between 0 and 2^31-2.",
          "type": "integer",
          "default": 2000,
          "maximum": 2147483646,
          "minimum": 0
        },
        "default_header_type": {
          "description": "Allows specifying the type of header to be added to requests with no pre-existing tracing headers and when `config.header_type` is set to `\"preserve\"`. When `header_type` is set to any other value, `default_header_type` is ignored.",
          "type": "string",
          "default": "b3",
          "enum": [
            "aws",
            "b3",
            "b3-single",
            "datadog",
            "gcp",
            "instana",
            "jaeger",
            "ot",
            "w3c"
          ]
        },
        "default_service_name": {
          "description": "Set a default service name to override `unknown-service-name` in the Zipkin spans.",
          "type": "string"
        },
        "header_type": {
          "description": "All HTTP requests going through the plugin are tagged with a tracing HTTP request. This property codifies what kind of tracing header the plugin expects on incoming requests",
          "type": "string",
          "default": "preserve",
          "enum": [
            "aws",
            "b3",
            "b3-single",
            "datadog",
            "gcp",
            "ignore",
            "instana",
            "jaeger",
            "ot",
            "preserve",
            "w3c"
          ]
        },
        "http_endpoint": {
          "description": "A string representing a URL, such as https://example.com/path/to/resource?q=search.",
          "type": "string"
        },
        "http_response_header_for_traceid": {
          "type": "string"
        },
        "http_span_name": {
          "description": "Specify whether to include the HTTP path in the span name.",
          "type": "string",
          "default": "method",
          "enum": [
            "method",
            "method_path"
          ]
        },
        "include_credential": {
          "description": "Specify whether the credential of the currently authenticated consumer should be included in metadata sent to the Zipkin server.",
          "type": "boolean",
          "default": true
        },
        "local_service_name": {
          "description": "The name of the service as displayed in Zipkin.",
          "type": "string",
          "default": "kong"
        },
        "phase_duration_flavor": {
          "description": "Specify whether to include the duration of each phase as an annotation or a tag.",
          "type": "string",
          "default": "annotations",
          "enum": [
            "annotations",
            "tags"
          ]
        },
        "propagation": {
          "type": "object",
          "default": {
            "default_format": "b3"
          },
          "properties": {
            "clear": {
              "description": "Header names to clear after context extraction. This allows to extract the context from a certain header and then remove it from the request, useful when extraction and injection are performed on different header formats and the original header should not be sent to the upstream. If left empty, no headers are cleared.",
              "type": "array",
              "items": {
                "type": "string"
              }
            },
            "default_format": {
              "description": "The default header format to use when extractors did not match any format in the incoming headers and `inject` is configured with the value: `preserve`. This can happen when no tracing header was found in the request, or the incoming tracing header formats were not included in `extract`.",
              "type": "string",
              "default": "b3",
              "enum": [
                "aws",
                "b3",
                "b3-single",
                "datadog",
                "gcp",
                "instana",
                "jaeger",
                "ot",
                "w3c"
              ]
            },
            "extract": {
              "description": "Header formats used to extract tracing context from incoming requests. If multiple values are specified, the first one found will be used for extraction. If left empty, Kong will not extract any tracing context information from incoming requests and generate a trace with no parent and a new trace ID.",
              "type": "array",
              "items": {
                "enum": [
                  "aws",
                  "b3",
                  "datadog",
                  "gcp",
                  "instana",
                  "jaeger",
                  "ot",
                  "w3c"
                ],
                "type": "string"
              }
            },
            "inject": {
              "description": "Header formats used to inject tracing context. The value `preserve` will use the same header format as the incoming request. If multiple values are specified, all of them will be used during injection. If left empty, Kong will not inject any tracing context information in outgoing requests.",
              "type": "array",
              "items": {
                "enum": [
                  "aws",
                  "b3",
                  "b3-single",
                  "datadog",
                  "gcp",
                  "instana",
                  "jaeger",
                  "ot",
                  "preserve",
                  "w3c"
                ],
                "type": "string"
              }
            }
          }
        },
        "queue": {
          "type": "object",
          "properties": {
            "concurrency_limit": {
              "description": "The number of of queue delivery timers. -1 indicates unlimited.",
              "type": "integer",
              "default": 1,
              "enum": [
                -1,
                1
              ]
            },
            "initial_retry_delay": {
              "description": "Time in seconds before the initial retry is made for a failing batch.",
              "type": "number",
              "default": 0.01,
              "maximum": 1000000,
              "minimum": 0.001
            },
            "max_batch_size": {
              "description": "Maximum number of entries that can be processed at a time.",
              "type": "integer",
              "default": 1,
              "maximum": 1000000,
              "minimum": 1
            },
            "max_bytes": {
              "description": "Maximum number of bytes that can be waiting on a queue, requires string content.",
              "type": "integer"
            },
            "max_coalescing_delay": {
              "description": "Maximum number of (fractional) seconds to elapse after the first entry was queued before the queue starts calling the handler.",
              "type": "number",
              "default": 1,
              "maximum": 3600,
              "minimum": 0
            },
            "max_entries": {
              "description": "Maximum number of entries that can be waiting on the queue.",
              "type": "integer",
              "default": 10000,
              "maximum": 1000000,
              "minimum": 1
            },
            "max_retry_delay": {
              "description": "Maximum time in seconds between retries, caps exponential backoff.",
              "type": "number",
              "default": 60,
              "maximum": 1000000,
              "minimum": 0.001
            },
            "max_retry_time": {
              "description": "Time in seconds before the queue gives up calling a failed handler for a batch.",
              "type": "number",
              "default": 60
            }
          }
        },
        "read_timeout": {
          "description": "An integer representing a timeout in milliseconds. Must be between 0 and 2^31-2.",
          "type": "integer",
          "default": 5000,
          "maximum": 2147483646,
          "minimum": 0
        },
        "sample_ratio": {
          "description": "How often to sample requests that do not contain trace IDs. Set to `0` to turn sampling off, or to `1` to sample **all** requests. ",
          "type": "number",
          "default": 0.001,
          "maximum": 1,
          "minimum": 0
        },
        "send_timeout": {
          "description": "An integer representing a timeout in milliseconds. Must be between 0 and 2^31-2.",
          "type": "integer",
          "default": 5000,
          "maximum": 2147483646,
          "minimum": 0
        },
        "static_tags": {
          "description": "The tags specified on this property will be added to the generated request traces.",
          "type": "array",
          "items": {
            "properties": {
              "name": {
                "type": "string"
              },
              "value": {
                "type": "string"
              }
            },
            "required": [
              "name",
              "value"
            ],
            "type": "object"
          }
        },
        "tags_header": {
          "description": "The Zipkin plugin will add extra headers to the tags associated with any HTTP requests that come with a header named as configured by this property.",
          "type": "string",
          "default": "Zipkin-Tags"
        },
        "traceid_byte_count": {
          "description": "The length in bytes of each request's Trace ID.",
          "type": "integer",
          "default": 16,
          "enum": [
            8,
            16
          ]
        }
      }
    },
    "consumer": {
      "description": "If set, the plugin will activate only for requests where the specified has been authenticated. (Note that some plugins can not be restricted to consumers this way.). Leave unset for the plugin to activate regardless of the authenticated Consumer.",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "id": {
          "type": "string"
        }
      }
    },
    "name": {
      "const": "zipkin"
    },
    "protocols": {
      "description": "A set of strings representing protocols.",
      "type": "array",
      "items": {
        "description": "A string representing a protocol, such as HTTP or HTTPS.",
        "enum": [
          "grpc",
          "grpcs",
          "http",
          "https",
          "tcp",
          "tls",
          "tls_passthrough",
          "udp",
          "ws",
          "wss"
        ],
        "type": "string"
      },
      "format": "set",
      "default": [
        "grpc",
        "grpcs",
        "http",
        "https"
      ]
    },
    "route": {
      "description": "If set, the plugin will only activate when receiving requests via the specified route. Leave unset for the plugin to activate regardless of the route being used.",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "id": {
          "type": "string"
        }
      }
    },
    "service": {
      "description": "If set, the plugin will only activate when receiving requests via one of the routes belonging to the specified Service. Leave unset for the plugin to activate regardless of the Service being matched.",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "id": {
          "type": "string"
        }
      }
    }
  }
}