Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
1 change: 1 addition & 0 deletions Markdown
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
jsonschema2md -d schema -o docs -e .json -x -
155 changes: 155 additions & 0 deletions docs/spec/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,155 @@
# README

## Top-level Schemas

* [Declaritive Config - Resource](./resource.md) – `https://opentelemetry.io/otelconfig/resource.json`

* [OpenTelemetryConfiguration](./opentelemetry_configuration.md) – `https://opentelemetry.io/otelconfig/opentelemetry_configuration.json`

* [Untitled object in undefined](./instrumentation.md) – `https://opentelemetry.io/otelconfig/instrumentation.json`

* [Untitled object in undefined](./logger_provider.md) – `https://opentelemetry.io/otelconfig/logger_provider.json`

* [Untitled object in undefined](./meter_provider.md) – `https://opentelemetry.io/otelconfig/meter_provider.json`

* [Untitled object in undefined](./propagator.md) – `https://opentelemetry.io/otelconfig/propagator.json`

* [Untitled object in undefined](./tracer_provider.md) – `https://opentelemetry.io/otelconfig/tracer_provider.json`

* [Untitled schema](./common.md) – `https://opentelemetry.io/otelconfig/common.json`

## Other Schemas

### Objects

* [Untitled object in Declaritive Config - Resource](./resource-defs-attributenamevalue.md) – `https://opentelemetry.io/otelconfig/resource.json#/$defs/AttributeNameValue`

* [Untitled object in Declaritive Config - Resource](./resource-defs-experimentalresourcedetection.md) – `https://opentelemetry.io/otelconfig/resource.json#/$defs/ExperimentalResourceDetection`

* [Untitled object in Declaritive Config - Resource](./resource-defs-experimentalresourcedetector.md) – `https://opentelemetry.io/otelconfig/resource.json#/$defs/ExperimentalResourceDetector`

* [Untitled object in OpenTelemetryConfiguration](./opentelemetry_configuration-defs-attributelimits.md) – `https://opentelemetry.io/otelconfig/opentelemetry_configuration.json#/$defs/AttributeLimits`

* [Untitled object in undefined](./common-defs-includeexclude.md) – `https://opentelemetry.io/otelconfig/common.json#/$defs/IncludeExclude`

* [Untitled object in undefined](./common-defs-namestringvaluepair.md) – `https://opentelemetry.io/otelconfig/common.json#/$defs/NameStringValuePair`

* [Untitled object in undefined](./instrumentation-defs-experimentalpeerinstrumentation-properties-service_mapping-items.md) – `https://opentelemetry.io/otelconfig/instrumentation.json#/$defs/ExperimentalPeerInstrumentation/properties/service_mapping/items`

* [Untitled object in undefined](./instrumentation-defs-experimentalhttpinstrumentation-properties-client.md) – `https://opentelemetry.io/otelconfig/instrumentation.json#/$defs/ExperimentalHttpInstrumentation/properties/client`

* [Untitled object in undefined](./instrumentation-defs-experimentalhttpinstrumentation-properties-server.md) – `https://opentelemetry.io/otelconfig/instrumentation.json#/$defs/ExperimentalHttpInstrumentation/properties/server`

* [Untitled object in undefined](./instrumentation-defs-experimentallanguagespecificinstrumentation-patternproperties-.md) – `https://opentelemetry.io/otelconfig/instrumentation.json#/$defs/ExperimentalLanguageSpecificInstrumentation/patternProperties/.*`

* [Untitled object in undefined](./instrumentation-defs-experimentalgeneralinstrumentation.md) – `https://opentelemetry.io/otelconfig/instrumentation.json#/$defs/ExperimentalGeneralInstrumentation`

* [Untitled object in undefined](./instrumentation-defs-experimentalpeerinstrumentation.md) – `https://opentelemetry.io/otelconfig/instrumentation.json#/$defs/ExperimentalPeerInstrumentation`

* [Untitled object in undefined](./instrumentation-defs-experimentalhttpinstrumentation.md) – `https://opentelemetry.io/otelconfig/instrumentation.json#/$defs/ExperimentalHttpInstrumentation`

* [Untitled object in undefined](./instrumentation-defs-experimentallanguagespecificinstrumentation.md) – `https://opentelemetry.io/otelconfig/instrumentation.json#/$defs/ExperimentalLanguageSpecificInstrumentation`

* [Untitled object in undefined](./logger_provider-defs-simplelogrecordprocessor.md) – `https://opentelemetry.io/otelconfig/logger_provider.json#/$defs/SimpleLogRecordProcessor`

* [Untitled object in undefined](./logger_provider-defs-batchlogrecordprocessor.md) – `https://opentelemetry.io/otelconfig/logger_provider.json#/$defs/BatchLogRecordProcessor`

* [Untitled object in undefined](./logger_provider-defs-logrecordexporter.md) – `https://opentelemetry.io/otelconfig/logger_provider.json#/$defs/LogRecordExporter`

* [Untitled object in undefined](./logger_provider-defs-logrecordlimits.md) – `https://opentelemetry.io/otelconfig/logger_provider.json#/$defs/LogRecordLimits`

* [Untitled object in undefined](./logger_provider-defs-logrecordprocessor.md) – `https://opentelemetry.io/otelconfig/logger_provider.json#/$defs/LogRecordProcessor`

* [Untitled object in undefined](./meter_provider-defs-periodicmetricreader.md) – `https://opentelemetry.io/otelconfig/meter_provider.json#/$defs/PeriodicMetricReader`

* [Untitled object in undefined](./meter_provider-defs-pullmetricreader.md) – `https://opentelemetry.io/otelconfig/meter_provider.json#/$defs/PullMetricReader`

* [Untitled object in undefined](./meter_provider-defs-cardinalitylimits.md) – `https://opentelemetry.io/otelconfig/meter_provider.json#/$defs/CardinalityLimits`

* [Untitled object in undefined](./meter_provider-defs-pushmetricexporter.md) – `https://opentelemetry.io/otelconfig/meter_provider.json#/$defs/PushMetricExporter`

* [Untitled object in undefined](./meter_provider-defs-metricproducer.md) – `https://opentelemetry.io/otelconfig/meter_provider.json#/$defs/MetricProducer`

* [Untitled object in undefined](./meter_provider-defs-metricreader.md) – `https://opentelemetry.io/otelconfig/meter_provider.json#/$defs/MetricReader`

* [Untitled object in undefined](./meter_provider-defs-view.md) – `https://opentelemetry.io/otelconfig/meter_provider.json#/$defs/View`

* [Untitled object in undefined](./meter_provider-defs-viewselector.md) – `https://opentelemetry.io/otelconfig/meter_provider.json#/$defs/ViewSelector`

* [Untitled object in undefined](./meter_provider-defs-viewstream.md) – `https://opentelemetry.io/otelconfig/meter_provider.json#/$defs/ViewStream`

* [Untitled object in undefined](./meter_provider-defs-aggregation.md) – `https://opentelemetry.io/otelconfig/meter_provider.json#/$defs/Aggregation`

* [Untitled object in undefined](./propagator-defs-textmappropagator.md) – `https://opentelemetry.io/otelconfig/propagator.json#/$defs/TextMapPropagator`

* [Untitled object in undefined](./tracer_provider-defs-batchspanprocessor.md) – `https://opentelemetry.io/otelconfig/tracer_provider.json#/$defs/BatchSpanProcessor`

* [Untitled object in undefined](./tracer_provider-defs-sampler.md) – `https://opentelemetry.io/otelconfig/tracer_provider.json#/$defs/Sampler`

* [Untitled object in undefined](./tracer_provider-defs-simplespanprocessor.md) – `https://opentelemetry.io/otelconfig/tracer_provider.json#/$defs/SimpleSpanProcessor`

* [Untitled object in undefined](./tracer_provider-defs-spanexporter.md) – `https://opentelemetry.io/otelconfig/tracer_provider.json#/$defs/SpanExporter`

* [Untitled object in undefined](./tracer_provider-defs-spanlimits.md) – `https://opentelemetry.io/otelconfig/tracer_provider.json#/$defs/SpanLimits`

* [Untitled object in undefined](./tracer_provider-defs-spanprocessor.md) – `https://opentelemetry.io/otelconfig/tracer_provider.json#/$defs/SpanProcessor`

### Arrays

* [Untitled array in Declaritive Config - Resource](./resource-properties-attributes.md) – `https://opentelemetry.io/otelconfig/resource.json#/properties/attributes`

* [Untitled array in Declaritive Config - Resource](./resource-defs-attributenamevalue-properties-value-oneof-4.md) – `https://opentelemetry.io/otelconfig/resource.json#/$defs/AttributeNameValue/properties/value/oneOf/4`

* [Untitled array in Declaritive Config - Resource](./resource-defs-attributenamevalue-properties-value-oneof-5.md) – `https://opentelemetry.io/otelconfig/resource.json#/$defs/AttributeNameValue/properties/value/oneOf/5`

* [Untitled array in Declaritive Config - Resource](./resource-defs-attributenamevalue-properties-value-oneof-6.md) – `https://opentelemetry.io/otelconfig/resource.json#/$defs/AttributeNameValue/properties/value/oneOf/6`

* [Untitled array in Declaritive Config - Resource](./resource-defs-experimentalresourcedetection-properties-detectors.md) – `https://opentelemetry.io/otelconfig/resource.json#/$defs/ExperimentalResourceDetection/properties/detectors`

* [Untitled array in undefined](./common-defs-includeexclude-properties-included.md) – `https://opentelemetry.io/otelconfig/common.json#/$defs/IncludeExclude/properties/included`

* [Untitled array in undefined](./common-defs-includeexclude-properties-excluded.md) – `https://opentelemetry.io/otelconfig/common.json#/$defs/IncludeExclude/properties/excluded`

* [Untitled array in undefined](./common-defs-otlphttpexporter-properties-headers.md) – `https://opentelemetry.io/otelconfig/common.json#/$defs/OtlpHttpExporter/properties/headers`

* [Untitled array in undefined](./common-defs-otlpgrpcexporter-properties-headers.md) – `https://opentelemetry.io/otelconfig/common.json#/$defs/OtlpGrpcExporter/properties/headers`

* [Untitled array in undefined](./instrumentation-defs-experimentalpeerinstrumentation-properties-service_mapping.md) – `https://opentelemetry.io/otelconfig/instrumentation.json#/$defs/ExperimentalPeerInstrumentation/properties/service_mapping`

* [Untitled array in undefined](./instrumentation-defs-experimentalhttpinstrumentation-properties-client-properties-request_captured_headers.md) – `https://opentelemetry.io/otelconfig/instrumentation.json#/$defs/ExperimentalHttpInstrumentation/properties/client/properties/request_captured_headers`

* [Untitled array in undefined](./instrumentation-defs-experimentalhttpinstrumentation-properties-client-properties-response_captured_headers.md) – `https://opentelemetry.io/otelconfig/instrumentation.json#/$defs/ExperimentalHttpInstrumentation/properties/client/properties/response_captured_headers`

* [Untitled array in undefined](./instrumentation-defs-experimentalhttpinstrumentation-properties-server-properties-request_captured_headers.md) – `https://opentelemetry.io/otelconfig/instrumentation.json#/$defs/ExperimentalHttpInstrumentation/properties/server/properties/request_captured_headers`

* [Untitled array in undefined](./instrumentation-defs-experimentalhttpinstrumentation-properties-server-properties-response_captured_headers.md) – `https://opentelemetry.io/otelconfig/instrumentation.json#/$defs/ExperimentalHttpInstrumentation/properties/server/properties/response_captured_headers`

* [Untitled array in undefined](./logger_provider-properties-processors.md) – `https://opentelemetry.io/otelconfig/logger_provider.json#/properties/processors`

* [Untitled array in undefined](./logger_provider-defs-experimentalloggerconfigurator-properties-loggers.md) – `https://opentelemetry.io/otelconfig/logger_provider.json#/$defs/ExperimentalLoggerConfigurator/properties/loggers`

* [Untitled array in undefined](./meter_provider-properties-readers.md) – `https://opentelemetry.io/otelconfig/meter_provider.json#/properties/readers`

* [Untitled array in undefined](./meter_provider-defs-otlphttpmetricexporter-properties-headers.md) – `https://opentelemetry.io/otelconfig/meter_provider.json#/$defs/OtlpHttpMetricExporter/properties/headers`

* [Untitled array in undefined](./meter_provider-defs-otlpgrpcmetricexporter-properties-headers.md) – `https://opentelemetry.io/otelconfig/meter_provider.json#/$defs/OtlpGrpcMetricExporter/properties/headers`

* [Untitled array in undefined](./meter_provider-defs-periodicmetricreader-properties-producers.md) – `https://opentelemetry.io/otelconfig/meter_provider.json#/$defs/PeriodicMetricReader/properties/producers`

* [Untitled array in undefined](./meter_provider-defs-pullmetricreader-properties-producers.md) – `https://opentelemetry.io/otelconfig/meter_provider.json#/$defs/PullMetricReader/properties/producers`

* [Untitled array in undefined](./meter_provider-properties-views.md) – `https://opentelemetry.io/otelconfig/meter_provider.json#/properties/views`

* [Untitled array in undefined](./meter_provider-defs-explicitbuckethistogramaggregation-properties-boundaries.md) – `https://opentelemetry.io/otelconfig/meter_provider.json#/$defs/ExplicitBucketHistogramAggregation/properties/boundaries`

* [Untitled array in undefined](./meter_provider-defs-experimentalmeterconfigurator-properties-meters.md) – `https://opentelemetry.io/otelconfig/meter_provider.json#/$defs/ExperimentalMeterConfigurator/properties/meters`

* [Untitled array in undefined](./propagator-properties-composite.md) – `https://opentelemetry.io/otelconfig/propagator.json#/properties/composite`

* [Untitled array in undefined](./tracer_provider-properties-processors.md) – `https://opentelemetry.io/otelconfig/tracer_provider.json#/properties/processors`

* [Untitled array in undefined](./tracer_provider-defs-experimentaltracerconfigurator-properties-tracers.md) – `https://opentelemetry.io/otelconfig/tracer_provider.json#/$defs/ExperimentalTracerConfigurator/properties/tracers`

## Version Note

The schemas linked above follow the JSON Schema Spec version: `https://json-schema.org/draft/2020-12/schema`
15 changes: 15 additions & 0 deletions docs/spec/common-defs-consoleexporter.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
# Untitled schema Schema

```txt
https://opentelemetry.io/otelconfig/tracer_provider.json#/$defs/SpanExporter/properties/console
```



| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In |
| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------------------- |
| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Forbidden | none | [tracer\_provider.json\*](../schema/tracer_provider.json "open original schema") |

## console Type

`object` ([Details](common-defs-consoleexporter.md))
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
# Untitled schema Schema

```txt
https://opentelemetry.io/otelconfig/common.json#/$defs/ExperimentalOtlpFileExporter/properties/output_stream
```



| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In |
| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------ |
| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [common.json\*](../schema/common.json "open original schema") |

## output\_stream Type

`string`
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
# Untitled schema Schema

```txt
https://opentelemetry.io/otelconfig/common.json#/$defs/ExperimentalOtlpFileExporter/properties
```



| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In |
| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------ |
| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [common.json\*](../schema/common.json "open original schema") |

## properties Type

unknown
39 changes: 39 additions & 0 deletions docs/spec/common-defs-experimentalotlpfileexporter.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
# Untitled schema Schema

```txt
https://opentelemetry.io/otelconfig/tracer_provider.json#/$defs/SpanExporter/properties/otlp_file/development
```



| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In |
| :------------------ | :--------- | :------------- | :----------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------------------- |
| Can be instantiated | No | Unknown status | No | Forbidden | Forbidden | none | [tracer\_provider.json\*](../schema/tracer_provider.json "open original schema") |

## development Type

`object` ([Details](common-defs-experimentalotlpfileexporter.md))

# development Properties

| Property | Type | Required | Nullable | Defined by |
| :------------------------------- | :------- | :------- | :---------- | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| [output\_stream](#output_stream) | `string` | Optional | can be null | [Untitled schema](common-defs-experimentalotlpfileexporter-properties-output_stream.md "https://opentelemetry.io/otelconfig/common.json#/$defs/ExperimentalOtlpFileExporter/properties/output_stream") |

## output\_stream



`output_stream`

* is optional

* Type: `string`

* can be null

* defined in: [Untitled schema](common-defs-experimentalotlpfileexporter-properties-output_stream.md "https://opentelemetry.io/otelconfig/common.json#/$defs/ExperimentalOtlpFileExporter/properties/output_stream")

### output\_stream Type

`string`
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
# Untitled string in undefined Schema

```txt
https://opentelemetry.io/otelconfig/common.json#/$defs/IncludeExclude/properties/excluded/items
```



| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In |
| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------ |
| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [common.json\*](../schema/common.json "open original schema") |

## items Type

`string`
15 changes: 15 additions & 0 deletions docs/spec/common-defs-includeexclude-properties-excluded.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
# Untitled array in undefined Schema

```txt
https://opentelemetry.io/otelconfig/common.json#/$defs/IncludeExclude/properties/excluded
```



| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In |
| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------ |
| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [common.json\*](../schema/common.json "open original schema") |

## excluded Type

`string[]`
Loading
Loading