tracer_configuration.schema.json

{
  "$schema": "http://json-schema.org/schema#",
  "title": "TracerConfiguration",
  "description": "Configuration for a LightStep tracer",
  "type": "object",
  "required": ["access_token"],
  "properties": {
    "component_name": {
      "type": "string",
      "description": "`component_name` is the human-readable identity of the instrumented\nprocess. I.e., if one drew a block diagram of the distributed system,\nthe component_name would be the name inside the box that includes this\nprocess."
    },

    "access_token": {
      "type": "string",
      "description": "`access_token` is the unique API key for your LightStep project. It is\navailable on your account page at https://app.lightstep.com/account"
    },

    "collector_host": {
      "type": "string",
      "description": "The host to use when comunicating with the LightStep collector."
    },
    "collector_port": {
      "type": "integer",
      "minimum": 1,
      "maximum": 65535,
      "description": "The port to use when communicating with the LightStep collector."
    },
    "collector_plaintext": {
      "type": "boolean",
      "description": "Whether to use plaintext or not when communicating with the LightStep collector."
    },

    "use_single_key_propagation": {
      "type": "boolean",
      "description": "Set `use_single_key_propagation` to Inject/Extract span context as a single\nkey in TextMap and HTTPHeaders carriers."
    },

    "max_buffered_spans": {
      "type": "integer",
      "minimum": 1,
      "description": "`max_buffered_spans` is the maximum number of spans that will be buffered\nbefore sending them to a collector."
    },

    "reporting_period": {
      "type": "integer",
      "minimum": 1,
      "description": "`reporting_period` is the maximum duration of time between sending spans\nto a collector. (In microseconds)."
    },

    "report_timeout": {
      "type": "integer",
      "minimum": 1,
      "description": "`report_timeout` is the timeout to use when sending a reports to the\ncollector. (In microseconds)."
    },

    "ssl_root_certificates": {
      "type": "string",
      "description": "`ssl_root_certificates` specifies the CA certificates to use when\ntransporting spans to the collector.  If not set, LightStep will try to\nuse CA certificates located in standard system locations.\n\nNote: `ssl_root_certificates` should follow the PEM format."
    },

    "use_stream_recorder": {
      "type": "boolean",
      "description": "`use_stream_recorder` enables the streaming recorder for faster uploading of spans."
    },

    "satellite_endpoints": {
      "type": "array",
      "items": { "$ref": "#/definitions/endpoint" },
      "description": "A list of satellite endpoints to upload spans to."
    },

    "verbose": {
      "type": "boolean",
      "description": "Log at the debug level."
    },

    "propagation_modes": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "A list of propagation modes to use for injection/extraction.\nValid values are \"lightstep\", \"b3\", \"envoy\", and \"trace_context\"."
    },

    "tags": {
      "type": "object",
      "description": "Arbitrary key-value pairs that apply to all spans generated by this Tracer."
    }
  },
  "definitions": {
    "endpoint": {
      "type": "object",
      "required": [ "host", "port" ],
      "properties": {
        "host": {
          "type": "string",
          "description": "The host of an address."
        },
        "port": {
          "type": "integer",
          "minimum": 1,
          "maximum": 65535,
          "description": "The port of an address."
        }
      }
    }
  }
}