tracingservice_v3alpha1.json

{
  "description": "TracingService is the Schema for the tracingservices API",
  "properties": {
    "apiVersion": {
      "description": "APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources",
      "type": "string"
    },
    "kind": {
      "description": "Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds",
      "type": "string"
    },
    "metadata": {
      "type": "object"
    },
    "spec": {
      "description": "TracingServiceSpec defines the desired state of TracingService",
      "properties": {
        "ambassador_id": {
          "description": "AmbassadorID declares which Ambassador instances should pay attention to this resource. If no value is provided, the default is: \n \tambassador_id: \t- \"default\" \n TODO(lukeshu): In v3alpha2, consider renaming all of the `ambassador_id` (singular) fields to `ambassador_ids` (plural).",
          "items": {
            "type": "string"
          },
          "type": "array"
        },
        "config": {
          "properties": {
            "access_token_file": {
              "type": "string"
            },
            "collector_cluster": {
              "type": "string"
            },
            "collector_endpoint": {
              "type": "string"
            },
            "collector_endpoint_version": {
              "enum": [
                "HTTP_JSON_V1",
                "HTTP_JSON",
                "HTTP_PROTO"
              ],
              "type": "string"
            },
            "collector_hostname": {
              "type": "string"
            },
            "propagation_modes": {
              "items": {
                "enum": [
                  "ENVOY",
                  "LIGHTSTEP",
                  "B3",
                  "TRACE_CONTEXT"
                ],
                "type": "string"
              },
              "type": "array"
            },
            "service_name": {
              "type": "string"
            },
            "shared_span_context": {
              "type": "boolean"
            },
            "trace_id_128bit": {
              "type": "boolean"
            }
          },
          "type": "object",
          "additionalProperties": false
        },
        "custom_tags": {
          "items": {
            "description": "TracingCustomTag provides a data structure for capturing envoy's `type.tracing.v3.CustomTag`",
            "properties": {
              "environment": {
                "description": "Environment explicitly specifies the protocol stack to set up. Exactly one of Literal, Environment or Header must be supplied.",
                "properties": {
                  "default_value": {
                    "type": "string"
                  },
                  "name": {
                    "type": "string"
                  }
                },
                "required": [
                  "name"
                ],
                "type": "object",
                "additionalProperties": false
              },
              "literal": {
                "description": "Literal explicitly specifies the protocol stack to set up. Exactly one of Literal, Environment or Header must be supplied.",
                "properties": {
                  "value": {
                    "type": "string"
                  }
                },
                "required": [
                  "value"
                ],
                "type": "object",
                "additionalProperties": false
              },
              "request_header": {
                "description": "Header explicitly specifies the protocol stack to set up. Exactly one of Literal, Environment or Header must be supplied.",
                "properties": {
                  "default_value": {
                    "type": "string"
                  },
                  "name": {
                    "type": "string"
                  }
                },
                "required": [
                  "name"
                ],
                "type": "object",
                "additionalProperties": false
              },
              "tag": {
                "type": "string"
              }
            },
            "required": [
              "tag"
            ],
            "type": "object",
            "additionalProperties": false
          },
          "type": "array"
        },
        "driver": {
          "enum": [
            "lightstep",
            "zipkin",
            "datadog",
            "opentelemetry"
          ],
          "type": "string"
        },
        "sampling": {
          "properties": {
            "client": {
              "type": "integer"
            },
            "overall": {
              "type": "integer"
            },
            "random": {
              "type": "integer"
            }
          },
          "type": "object",
          "additionalProperties": false
        },
        "service": {
          "type": "string"
        },
        "stats_name": {
          "type": "string"
        },
        "tag_headers": {
          "description": "Deprecated: tag_headers is deprecated. Use custom_tags instead. `tag_headers: [\"header\"]` can be defined as `custom_tags: [{\"request_header\": {\"name\": \"header\"}}]`.",
          "items": {
            "type": "string"
          },
          "type": "array"
        }
      },
      "required": [
        "driver",
        "service"
      ],
      "type": "object",
      "additionalProperties": false
    }
  },
  "type": "object"
}