@intentius/chant-lexicon-otel 0.81.0

package/dist/meta.json

@@ -0,0 +1,102 @@
+{
+  "AttributesProcessor": {
+    "resourceType": "OTel::Processor::attributes",
+    "kind": "resource",
+    "lexicon": "otel"
+  },
+  "BatchProcessor": {
+    "resourceType": "OTel::Processor::batch",
+    "kind": "resource",
+    "lexicon": "otel"
+  },
+  "DebugExporter": {
+    "resourceType": "OTel::Exporter::debug",
+    "kind": "resource",
+    "lexicon": "otel"
+  },
+  "FileLogReceiver": {
+    "resourceType": "OTel::Receiver::filelog",
+    "kind": "resource",
+    "lexicon": "otel"
+  },
+  "GoogleCloudExporter": {
+    "resourceType": "OTel::Exporter::googlecloud",
+    "kind": "resource",
+    "lexicon": "otel"
+  },
+  "HealthCheckExtension": {
+    "resourceType": "OTel::Extension::health_check",
+    "kind": "resource",
+    "lexicon": "otel"
+  },
+  "HostMetricsReceiver": {
+    "resourceType": "OTel::Receiver::hostmetrics",
+    "kind": "resource",
+    "lexicon": "otel"
+  },
+  "K8sAttributesProcessor": {
+    "resourceType": "OTel::Processor::k8sattributes",
+    "kind": "resource",
+    "lexicon": "otel"
+  },
+  "MemoryLimiterProcessor": {
+    "resourceType": "OTel::Processor::memory_limiter",
+    "kind": "resource",
+    "lexicon": "otel"
+  },
+  "OtlpExporter": {
+    "resourceType": "OTel::Exporter::otlp",
+    "kind": "resource",
+    "lexicon": "otel"
+  },
+  "OtlpHttpExporter": {
+    "resourceType": "OTel::Exporter::otlphttp",
+    "kind": "resource",
+    "lexicon": "otel"
+  },
+  "OtlpReceiver": {
+    "resourceType": "OTel::Receiver::otlp",
+    "kind": "resource",
+    "lexicon": "otel"
+  },
+  "Pipeline": {
+    "resourceType": "OTel::Pipeline",
+    "kind": "resource",
+    "lexicon": "otel"
+  },
+  "PprofExtension": {
+    "resourceType": "OTel::Extension::pprof",
+    "kind": "resource",
+    "lexicon": "otel"
+  },
+  "PrometheusExporter": {
+    "resourceType": "OTel::Exporter::prometheus",
+    "kind": "resource",
+    "lexicon": "otel"
+  },
+  "PrometheusReceiver": {
+    "resourceType": "OTel::Receiver::prometheus",
+    "kind": "resource",
+    "lexicon": "otel"
+  },
+  "ResourceDetectionProcessor": {
+    "resourceType": "OTel::Processor::resourcedetection",
+    "kind": "resource",
+    "lexicon": "otel"
+  },
+  "ResourceProcessor": {
+    "resourceType": "OTel::Processor::resource",
+    "kind": "resource",
+    "lexicon": "otel"
+  },
+  "Service": {
+    "resourceType": "OTel::Service",
+    "kind": "resource",
+    "lexicon": "otel"
+  },
+  "ZPagesExtension": {
+    "resourceType": "OTel::Extension::zpages",
+    "kind": "resource",
+    "lexicon": "otel"
+  }
+}

package/dist/model.d.ts

@@ -0,0 +1,53 @@
+/**
+ * The plain-data model of an OpenTelemetry Collector config.
+ *
+ * Everything else in this lexicon reads or writes this shape: the serializer
+ * builds it from declared entities, the YAML emitter prints it, the checks
+ * validate it, and `collectorTopology()` reads it back for other tools. It is
+ * exactly the collector's own top-level layout, so a parsed collector YAML
+ * file is already a `CollectorConfig` and needs no conversion.
+ */
+/** The three signals a collector pipeline can carry. */
+export declare const SIGNALS: readonly ["traces", "metrics", "logs"];
+export type Signal = (typeof SIGNALS)[number];
+/** The component kinds this lexicon types. Connectors are not modeled yet. */
+export declare const COMPONENT_KINDS: readonly ["receiver", "processor", "exporter", "extension"];
+export type ComponentKind = (typeof COMPONENT_KINDS)[number];
+/** The top-level config section each component kind lives under. */
+export declare const SECTION_OF: Record<ComponentKind, "receivers" | "processors" | "exporters" | "extensions">;
+/** A component id, `type` or `type/name`, exactly as the collector spells it. */
+export type ComponentId = string;
+/** One pipeline under `service.pipelines`. */
+export interface PipelineConfig {
+    receivers?: ComponentId[];
+    processors?: ComponentId[];
+    exporters?: ComponentId[];
+}
+export interface ServiceConfig {
+    extensions?: ComponentId[];
+    telemetry?: Record<string, unknown>;
+    pipelines?: Record<string, PipelineConfig>;
+}
+/** A whole collector config file. Every section is optional so a partial file still parses. */
+export interface CollectorConfig {
+    receivers?: Record<ComponentId, Record<string, unknown> | null>;
+    processors?: Record<ComponentId, Record<string, unknown> | null>;
+    exporters?: Record<ComponentId, Record<string, unknown> | null>;
+    extensions?: Record<ComponentId, Record<string, unknown> | null>;
+    connectors?: Record<ComponentId, Record<string, unknown> | null>;
+    service?: ServiceConfig;
+}
+/** Build a component id from a type and an optional instance name. */
+export declare function componentId(type: string, name?: string): ComponentId;
+/** Split a component id into its type and name, or `undefined` when it isn't valid id syntax. */
+export declare function parseComponentId(id: string): {
+    type: string;
+    name?: string;
+} | undefined;
+/** True when `id` is a valid `type[/name]` component id. */
+export declare function isComponentId(id: string): boolean;
+/** The signal a pipeline id names, e.g. `traces` for `traces/backend`. */
+export declare function pipelineSignal(pipelineId: string): string;
+/** True when a parsed document has the shape of a collector config. */
+export declare function looksLikeCollectorConfig(value: unknown): value is CollectorConfig;
+//# sourceMappingURL=model.d.ts.map

package/dist/model.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"model.d.ts","sourceRoot":"","sources":["../src/model.ts"],"names":[],"mappings":"AAAA;;;;;;;;GAQG;AAEH,wDAAwD;AACxD,eAAO,MAAM,OAAO,wCAAyC,CAAC;AAC9D,MAAM,MAAM,MAAM,GAAG,CAAC,OAAO,OAAO,CAAC,CAAC,MAAM,CAAC,CAAC;AAE9C,8EAA8E;AAC9E,eAAO,MAAM,eAAe,6DAA8D,CAAC;AAC3F,MAAM,MAAM,aAAa,GAAG,CAAC,OAAO,eAAe,CAAC,CAAC,MAAM,CAAC,CAAC;AAE7D,oEAAoE;AACpE,eAAO,MAAM,UAAU,EAAE,MAAM,CAAC,aAAa,EAAE,WAAW,GAAG,YAAY,GAAG,WAAW,GAAG,YAAY,CAKrG,CAAC;AAEF,iFAAiF;AACjF,MAAM,MAAM,WAAW,GAAG,MAAM,CAAC;AAEjC,8CAA8C;AAC9C,MAAM,WAAW,cAAc;IAC7B,SAAS,CAAC,EAAE,WAAW,EAAE,CAAC;IAC1B,UAAU,CAAC,EAAE,WAAW,EAAE,CAAC;IAC3B,SAAS,CAAC,EAAE,WAAW,EAAE,CAAC;CAC3B;AAED,MAAM,WAAW,aAAa;IAC5B,UAAU,CAAC,EAAE,WAAW,EAAE,CAAC;IAC3B,SAAS,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IACpC,SAAS,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,cAAc,CAAC,CAAC;CAC5C;AAED,+FAA+F;AAC/F,MAAM,WAAW,eAAe;IAC9B,SAAS,CAAC,EAAE,MAAM,CAAC,WAAW,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,IAAI,CAAC,CAAC;IAChE,UAAU,CAAC,EAAE,MAAM,CAAC,WAAW,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,IAAI,CAAC,CAAC;IACjE,SAAS,CAAC,EAAE,MAAM,CAAC,WAAW,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,IAAI,CAAC,CAAC;IAChE,UAAU,CAAC,EAAE,MAAM,CAAC,WAAW,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,IAAI,CAAC,CAAC;IACjE,UAAU,CAAC,EAAE,MAAM,CAAC,WAAW,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,IAAI,CAAC,CAAC;IACjE,OAAO,CAAC,EAAE,aAAa,CAAC;CACzB;AAKD,sEAAsE;AACtE,wBAAgB,WAAW,CAAC,IAAI,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,MAAM,GAAG,WAAW,CAEpE;AAED,iGAAiG;AACjG,wBAAgB,gBAAgB,CAAC,EAAE,EAAE,MAAM,GAAG;IAAE,IAAI,EAAE,MAAM,CAAC;IAAC,IAAI,CAAC,EAAE,MAAM,CAAA;CAAE,GAAG,SAAS,CAIxF;AAED,4DAA4D;AAC5D,wBAAgB,aAAa,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAEjD;AAED,0EAA0E;AAC1E,wBAAgB,cAAc,CAAC,UAAU,EAAE,MAAM,GAAG,MAAM,CAGzD;AAED,uEAAuE;AACvE,wBAAgB,wBAAwB,CAAC,KAAK,EAAE,OAAO,GAAG,KAAK,IAAI,eAAe,CAQjF"}

package/dist/okf/index.md

@@ -0,0 +1,40 @@
+---
+okf_version: '0.2'
+---
+
+# Resource types
+
+* [AttributesProcessor](/types/AttributesProcessor.md) - OTel::Processor::attributes
+* [BatchProcessor](/types/BatchProcessor.md) - OTel::Processor::batch
+* [DebugExporter](/types/DebugExporter.md) - OTel::Exporter::debug
+* [FileLogReceiver](/types/FileLogReceiver.md) - OTel::Receiver::filelog
+* [GoogleCloudExporter](/types/GoogleCloudExporter.md) - OTel::Exporter::googlecloud
+* [HealthCheckExtension](/types/HealthCheckExtension.md) - OTel::Extension::health_check
+* [HostMetricsReceiver](/types/HostMetricsReceiver.md) - OTel::Receiver::hostmetrics
+* [K8sAttributesProcessor](/types/K8sAttributesProcessor.md) - OTel::Processor::k8sattributes
+* [MemoryLimiterProcessor](/types/MemoryLimiterProcessor.md) - OTel::Processor::memory_limiter
+* [OtlpExporter](/types/OtlpExporter.md) - OTel::Exporter::otlp
+* [OtlpHttpExporter](/types/OtlpHttpExporter.md) - OTel::Exporter::otlphttp
+* [OtlpReceiver](/types/OtlpReceiver.md) - OTel::Receiver::otlp
+* [Pipeline](/types/Pipeline.md) - OTel::Pipeline
+* [PprofExtension](/types/PprofExtension.md) - OTel::Extension::pprof
+* [PrometheusExporter](/types/PrometheusExporter.md) - OTel::Exporter::prometheus
+* [PrometheusReceiver](/types/PrometheusReceiver.md) - OTel::Receiver::prometheus
+* [ResourceDetectionProcessor](/types/ResourceDetectionProcessor.md) - OTel::Processor::resourcedetection
+* [ResourceProcessor](/types/ResourceProcessor.md) - OTel::Processor::resource
+* [Service](/types/Service.md) - OTel::Service
+* [ZPagesExtension](/types/ZPagesExtension.md) - OTel::Extension::zpages
+
+# Rules
+
+* [OTEL001](/rules/OTEL001.md) - a component id or instance name the collector can't parse.
+* [OTEL002](/rules/OTEL002.md) - a credential written as a literal in a component's config.
+* [OTEL101](/rules/OTEL101.md) - A pipeline uses a receiver, processor or exporter that is not declared
+* [OTEL102](/rules/OTEL102.md) - A pipeline has no receivers or no exporters
+* [OTEL103](/rules/OTEL103.md) - A declared component is never used
+* [OTEL104](/rules/OTEL104.md) - service.extensions enables an extension that is not declared
+* [OTEL105](/rules/OTEL105.md) - memory_limiter is not the first processor in a pipeline
+* [OTEL106](/rules/OTEL106.md) - A pipeline id or component reference is not valid collector syntax
+* [OTEL107](/rules/OTEL107.md) - A component's config breaks its definition's rules
+* [OTEL108](/rules/OTEL108.md) - Two components or two pipelines declare the same id
+* [OTEL109](/rules/OTEL109.md) - A custom component has no schema pin

package/dist/okf/rules/OTEL001.md

@@ -0,0 +1,15 @@
+---
+type: lint-rule
+title: OTEL001
+description: a component id or instance name the collector can't parse.
+id: OTEL001
+severity: error
+category: correctness
+lexicon: otel
+docs: https://intentius.io/chant/lexicons/otel/rules/
+---
+a component id or instance name the collector can't parse.
+
+## Applies to
+
+- [Pipeline](/types/Pipeline.md)

package/dist/okf/rules/OTEL002.md

@@ -0,0 +1,11 @@
+---
+type: lint-rule
+title: OTEL002
+description: a credential written as a literal in a component's config.
+id: OTEL002
+severity: error
+category: security
+lexicon: otel
+docs: https://intentius.io/chant/lexicons/otel/rules/
+---
+a credential written as a literal in a component's config.

package/dist/okf/rules/OTEL101.md

@@ -0,0 +1,11 @@
+---
+type: post-synth-check
+title: OTEL101
+description: A pipeline uses a receiver, processor or exporter that is not declared
+id: OTEL101
+severity: error
+category: post-synth
+lexicon: otel
+docs: https://intentius.io/chant/lexicons/otel/rules/
+---
+A pipeline uses a receiver, processor or exporter that is not declared

package/dist/okf/rules/OTEL102.md

@@ -0,0 +1,11 @@
+---
+type: post-synth-check
+title: OTEL102
+description: A pipeline has no receivers or no exporters
+id: OTEL102
+severity: error
+category: post-synth
+lexicon: otel
+docs: https://intentius.io/chant/lexicons/otel/rules/
+---
+A pipeline has no receivers or no exporters

package/dist/okf/rules/OTEL103.md

@@ -0,0 +1,11 @@
+---
+type: post-synth-check
+title: OTEL103
+description: A declared component is never used
+id: OTEL103
+severity: error
+category: post-synth
+lexicon: otel
+docs: https://intentius.io/chant/lexicons/otel/rules/
+---
+A declared component is never used

package/dist/okf/rules/OTEL104.md

@@ -0,0 +1,11 @@
+---
+type: post-synth-check
+title: OTEL104
+description: service.extensions enables an extension that is not declared
+id: OTEL104
+severity: error
+category: post-synth
+lexicon: otel
+docs: https://intentius.io/chant/lexicons/otel/rules/
+---
+service.extensions enables an extension that is not declared

package/dist/okf/rules/OTEL105.md

@@ -0,0 +1,11 @@
+---
+type: post-synth-check
+title: OTEL105
+description: memory_limiter is not the first processor in a pipeline
+id: OTEL105
+severity: error
+category: post-synth
+lexicon: otel
+docs: https://intentius.io/chant/lexicons/otel/rules/
+---
+memory_limiter is not the first processor in a pipeline

package/dist/okf/rules/OTEL106.md

@@ -0,0 +1,11 @@
+---
+type: post-synth-check
+title: OTEL106
+description: A pipeline id or component reference is not valid collector syntax
+id: OTEL106
+severity: error
+category: post-synth
+lexicon: otel
+docs: https://intentius.io/chant/lexicons/otel/rules/
+---
+A pipeline id or component reference is not valid collector syntax

package/dist/okf/rules/OTEL107.md

@@ -0,0 +1,11 @@
+---
+type: post-synth-check
+title: OTEL107
+description: A component's config breaks its definition's rules
+id: OTEL107
+severity: error
+category: post-synth
+lexicon: otel
+docs: https://intentius.io/chant/lexicons/otel/rules/
+---
+A component's config breaks its definition's rules

package/dist/okf/rules/OTEL108.md

@@ -0,0 +1,11 @@
+---
+type: post-synth-check
+title: OTEL108
+description: Two components or two pipelines declare the same id
+id: OTEL108
+severity: error
+category: post-synth
+lexicon: otel
+docs: https://intentius.io/chant/lexicons/otel/rules/
+---
+Two components or two pipelines declare the same id

package/dist/okf/rules/OTEL109.md

@@ -0,0 +1,11 @@
+---
+type: post-synth-check
+title: OTEL109
+description: A custom component has no schema pin
+id: OTEL109
+severity: error
+category: post-synth
+lexicon: otel
+docs: https://intentius.io/chant/lexicons/otel/rules/
+---
+A custom component has no schema pin

package/dist/okf/types/AttributesProcessor.md

@@ -0,0 +1,9 @@
+---
+type: resource-type
+title: AttributesProcessor
+description: otel resource type OTel::Processor::attributes
+name: AttributesProcessor
+lexicon: otel
+resource_type: OTel::Processor::attributes
+---
+`OTel::Processor::attributes`, a resource type of the otel lexicon.

package/dist/okf/types/BatchProcessor.md

@@ -0,0 +1,9 @@
+---
+type: resource-type
+title: BatchProcessor
+description: otel resource type OTel::Processor::batch
+name: BatchProcessor
+lexicon: otel
+resource_type: OTel::Processor::batch
+---
+`OTel::Processor::batch`, a resource type of the otel lexicon.

package/dist/okf/types/DebugExporter.md

@@ -0,0 +1,9 @@
+---
+type: resource-type
+title: DebugExporter
+description: otel resource type OTel::Exporter::debug
+name: DebugExporter
+lexicon: otel
+resource_type: OTel::Exporter::debug
+---
+`OTel::Exporter::debug`, a resource type of the otel lexicon.

package/dist/okf/types/FileLogReceiver.md

@@ -0,0 +1,9 @@
+---
+type: resource-type
+title: FileLogReceiver
+description: otel resource type OTel::Receiver::filelog
+name: FileLogReceiver
+lexicon: otel
+resource_type: OTel::Receiver::filelog
+---
+`OTel::Receiver::filelog`, a resource type of the otel lexicon.

package/dist/okf/types/GoogleCloudExporter.md

@@ -0,0 +1,9 @@
+---
+type: resource-type
+title: GoogleCloudExporter
+description: otel resource type OTel::Exporter::googlecloud
+name: GoogleCloudExporter
+lexicon: otel
+resource_type: OTel::Exporter::googlecloud
+---
+`OTel::Exporter::googlecloud`, a resource type of the otel lexicon.

package/dist/okf/types/HealthCheckExtension.md

@@ -0,0 +1,9 @@
+---
+type: resource-type
+title: HealthCheckExtension
+description: otel resource type OTel::Extension::health_check
+name: HealthCheckExtension
+lexicon: otel
+resource_type: OTel::Extension::health_check
+---
+`OTel::Extension::health_check`, a resource type of the otel lexicon.

package/dist/okf/types/HostMetricsReceiver.md

@@ -0,0 +1,9 @@
+---
+type: resource-type
+title: HostMetricsReceiver
+description: otel resource type OTel::Receiver::hostmetrics
+name: HostMetricsReceiver
+lexicon: otel
+resource_type: OTel::Receiver::hostmetrics
+---
+`OTel::Receiver::hostmetrics`, a resource type of the otel lexicon.

package/dist/okf/types/K8sAttributesProcessor.md

@@ -0,0 +1,9 @@
+---
+type: resource-type
+title: K8sAttributesProcessor
+description: otel resource type OTel::Processor::k8sattributes
+name: K8sAttributesProcessor
+lexicon: otel
+resource_type: OTel::Processor::k8sattributes
+---
+`OTel::Processor::k8sattributes`, a resource type of the otel lexicon.

package/dist/okf/types/MemoryLimiterProcessor.md

@@ -0,0 +1,9 @@
+---
+type: resource-type
+title: MemoryLimiterProcessor
+description: otel resource type OTel::Processor::memory_limiter
+name: MemoryLimiterProcessor
+lexicon: otel
+resource_type: OTel::Processor::memory_limiter
+---
+`OTel::Processor::memory_limiter`, a resource type of the otel lexicon.

package/dist/okf/types/OtlpExporter.md

@@ -0,0 +1,9 @@
+---
+type: resource-type
+title: OtlpExporter
+description: otel resource type OTel::Exporter::otlp
+name: OtlpExporter
+lexicon: otel
+resource_type: OTel::Exporter::otlp
+---
+`OTel::Exporter::otlp`, a resource type of the otel lexicon.

package/dist/okf/types/OtlpHttpExporter.md

@@ -0,0 +1,9 @@
+---
+type: resource-type
+title: OtlpHttpExporter
+description: otel resource type OTel::Exporter::otlphttp
+name: OtlpHttpExporter
+lexicon: otel
+resource_type: OTel::Exporter::otlphttp
+---
+`OTel::Exporter::otlphttp`, a resource type of the otel lexicon.

package/dist/okf/types/OtlpReceiver.md

@@ -0,0 +1,9 @@
+---
+type: resource-type
+title: OtlpReceiver
+description: otel resource type OTel::Receiver::otlp
+name: OtlpReceiver
+lexicon: otel
+resource_type: OTel::Receiver::otlp
+---
+`OTel::Receiver::otlp`, a resource type of the otel lexicon.

package/dist/okf/types/Pipeline.md

@@ -0,0 +1,13 @@
+---
+type: resource-type
+title: Pipeline
+description: otel resource type OTel::Pipeline
+name: Pipeline
+lexicon: otel
+resource_type: OTel::Pipeline
+---
+`OTel::Pipeline`, a resource type of the otel lexicon.
+
+## Governed by
+
+- [OTEL001](/rules/OTEL001.md): a component id or instance name the collector can't parse.

package/dist/okf/types/PprofExtension.md

@@ -0,0 +1,9 @@
+---
+type: resource-type
+title: PprofExtension
+description: otel resource type OTel::Extension::pprof
+name: PprofExtension
+lexicon: otel
+resource_type: OTel::Extension::pprof
+---
+`OTel::Extension::pprof`, a resource type of the otel lexicon.

package/dist/okf/types/PrometheusExporter.md

@@ -0,0 +1,9 @@
+---
+type: resource-type
+title: PrometheusExporter
+description: otel resource type OTel::Exporter::prometheus
+name: PrometheusExporter
+lexicon: otel
+resource_type: OTel::Exporter::prometheus
+---
+`OTel::Exporter::prometheus`, a resource type of the otel lexicon.

package/dist/okf/types/PrometheusReceiver.md

@@ -0,0 +1,9 @@
+---
+type: resource-type
+title: PrometheusReceiver
+description: otel resource type OTel::Receiver::prometheus
+name: PrometheusReceiver
+lexicon: otel
+resource_type: OTel::Receiver::prometheus
+---
+`OTel::Receiver::prometheus`, a resource type of the otel lexicon.

package/dist/okf/types/ResourceDetectionProcessor.md

@@ -0,0 +1,9 @@
+---
+type: resource-type
+title: ResourceDetectionProcessor
+description: otel resource type OTel::Processor::resourcedetection
+name: ResourceDetectionProcessor
+lexicon: otel
+resource_type: OTel::Processor::resourcedetection
+---
+`OTel::Processor::resourcedetection`, a resource type of the otel lexicon.

package/dist/okf/types/ResourceProcessor.md

@@ -0,0 +1,9 @@
+---
+type: resource-type
+title: ResourceProcessor
+description: otel resource type OTel::Processor::resource
+name: ResourceProcessor
+lexicon: otel
+resource_type: OTel::Processor::resource
+---
+`OTel::Processor::resource`, a resource type of the otel lexicon.

package/dist/okf/types/Service.md

@@ -0,0 +1,9 @@
+---
+type: resource-type
+title: Service
+description: otel resource type OTel::Service
+name: Service
+lexicon: otel
+resource_type: OTel::Service
+---
+`OTel::Service`, a resource type of the otel lexicon.

package/dist/okf/types/ZPagesExtension.md

@@ -0,0 +1,9 @@
+---
+type: resource-type
+title: ZPagesExtension
+description: otel resource type OTel::Extension::zpages
+name: ZPagesExtension
+lexicon: otel
+resource_type: OTel::Extension::zpages
+---
+`OTel::Extension::zpages`, a resource type of the otel lexicon.

package/dist/package-cli.d.ts

@@ -0,0 +1,3 @@
+#!/usr/bin/env tsx
+export {};
+//# sourceMappingURL=package-cli.d.ts.map

package/dist/package-cli.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"package-cli.d.ts","sourceRoot":"","sources":["../src/package-cli.ts"],"names":[],"mappings":""}

package/dist/pipeline.d.ts

@@ -0,0 +1,66 @@
+/**
+ * `Pipeline` and `Service`: the `service:` half of a collector config.
+ *
+ * A pipeline names its components either by the declared entity, which
+ * keeps the reference checked by TypeScript, or by id string (`otlp/backend`)
+ * for a component declared somewhere chant can't see. OTEL101 catches a
+ * string that names nothing declared.
+ */
+import type { Declarable } from "@intentius/chant/declarable";
+import type { OTelComponent } from "./define.js";
+import { type ComponentKind, type Signal } from "./model.js";
+/** A reference to a component of kind `K`: the declared entity, or its id. */
+export type ComponentRef<K extends ComponentKind> = OTelComponent<K, string, any> | string;
+export interface PipelineProps {
+    signal: Signal;
+    /** The instance name. The pipeline id becomes `signal/name`. */
+    name?: string;
+    receivers: ComponentRef<"receiver">[];
+    processors?: ComponentRef<"processor">[];
+    exporters: ComponentRef<"exporter">[];
+}
+export interface PipelineEntity extends Declarable {
+    readonly props: PipelineProps;
+    /** The pipeline id under `service.pipelines`, `signal` or `signal/name`. */
+    readonly pipelineId: string;
+}
+export declare const PIPELINE_TYPE = "OTel::Pipeline";
+export declare const SERVICE_TYPE = "OTel::Service";
+/** One entry under `service.pipelines`. */
+export declare const Pipeline: new (props: PipelineProps) => PipelineEntity;
+export interface ServiceTelemetry {
+    logs?: {
+        level?: "debug" | "info" | "warn" | "error";
+        encoding?: "console" | "json";
+        development?: boolean;
+        output_paths?: string[];
+        error_output_paths?: string[];
+        initial_fields?: Record<string, string>;
+        sampling?: Record<string, unknown>;
+    };
+    metrics?: {
+        level?: "none" | "basic" | "normal" | "detailed";
+        readers?: Array<Record<string, unknown>>;
+    };
+    traces?: {
+        processors?: Array<Record<string, unknown>>;
+        propagators?: string[];
+    };
+    resource?: Record<string, string>;
+}
+export interface ServiceProps {
+    /**
+     * Extensions to enable, in start order. Leave it out and every declared
+     * extension is enabled in declaration order.
+     */
+    extensions?: ComponentRef<"extension">[];
+    telemetry?: ServiceTelemetry;
+}
+export interface ServiceEntity extends Declarable {
+    readonly props: ServiceProps;
+}
+/** `service.extensions` and `service.telemetry`. Optional; declare at most one. */
+export declare const Service: new (props: ServiceProps) => ServiceEntity;
+export declare function isPipelineEntity(value: unknown): value is PipelineEntity;
+export declare function isServiceEntity(value: unknown): value is ServiceEntity;
+//# sourceMappingURL=pipeline.d.ts.map

package/dist/pipeline.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"pipeline.d.ts","sourceRoot":"","sources":["../src/pipeline.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AAGH,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,6BAA6B,CAAC;AAC9D,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,UAAU,CAAC;AAC9C,OAAO,EAAe,KAAK,aAAa,EAAE,KAAK,MAAM,EAAE,MAAM,SAAS,CAAC;AAEvE,8EAA8E;AAE9E,MAAM,MAAM,YAAY,CAAC,CAAC,SAAS,aAAa,IAAI,aAAa,CAAC,CAAC,EAAE,MAAM,EAAE,GAAG,CAAC,GAAG,MAAM,CAAC;AAE3F,MAAM,WAAW,aAAa;IAC5B,MAAM,EAAE,MAAM,CAAC;IACf,gEAAgE;IAChE,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,SAAS,EAAE,YAAY,CAAC,UAAU,CAAC,EAAE,CAAC;IACtC,UAAU,CAAC,EAAE,YAAY,CAAC,WAAW,CAAC,EAAE,CAAC;IACzC,SAAS,EAAE,YAAY,CAAC,UAAU,CAAC,EAAE,CAAC;CACvC;AAED,MAAM,WAAW,cAAe,SAAQ,UAAU;IAChD,QAAQ,CAAC,KAAK,EAAE,aAAa,CAAC;IAC9B,4EAA4E;IAC5E,QAAQ,CAAC,UAAU,EAAE,MAAM,CAAC;CAC7B;AAED,eAAO,MAAM,aAAa,mBAAmB,CAAC;AAC9C,eAAO,MAAM,YAAY,kBAAkB,CAAC;AAI5C,2CAA2C;AAC3C,eAAO,MAAM,QAAQ,EAGL,KAAK,KAAK,EAAE,aAAa,KAAK,cAAc,CAAC;AAG7D,MAAM,WAAW,gBAAgB;IAC/B,IAAI,CAAC,EAAE;QACL,KAAK,CAAC,EAAE,OAAO,GAAG,MAAM,GAAG,MAAM,GAAG,OAAO,CAAC;QAC5C,QAAQ,CAAC,EAAE,SAAS,GAAG,MAAM,CAAC;QAC9B,WAAW,CAAC,EAAE,OAAO,CAAC;QACtB,YAAY,CAAC,EAAE,MAAM,EAAE,CAAC;QACxB,kBAAkB,CAAC,EAAE,MAAM,EAAE,CAAC;QAC9B,cAAc,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;QACxC,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;KACpC,CAAC;IACF,OAAO,CAAC,EAAE;QACR,KAAK,CAAC,EAAE,MAAM,GAAG,OAAO,GAAG,QAAQ,GAAG,UAAU,CAAC;QACjD,OAAO,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC,CAAC;KAC1C,CAAC;IACF,MAAM,CAAC,EAAE;QACP,UAAU,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC,CAAC;QAC5C,WAAW,CAAC,EAAE,MAAM,EAAE,CAAC;KACxB,CAAC;IACF,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;CACnC;AAED,MAAM,WAAW,YAAY;IAC3B;;;OAGG;IACH,UAAU,CAAC,EAAE,YAAY,CAAC,WAAW,CAAC,EAAE,CAAC;IACzC,SAAS,CAAC,EAAE,gBAAgB,CAAC;CAC9B;AAED,MAAM,WAAW,aAAc,SAAQ,UAAU;IAC/C,QAAQ,CAAC,KAAK,EAAE,YAAY,CAAC;CAC9B;AAED,mFAAmF;AACnF,eAAO,MAAM,OAAO,EAA0D,KAAK,KAAK,EAAE,YAAY,KAAK,aAAa,CAAC;AAEzH,wBAAgB,gBAAgB,CAAC,KAAK,EAAE,OAAO,GAAG,KAAK,IAAI,cAAc,CAExE;AAED,wBAAgB,eAAe,CAAC,KAAK,EAAE,OAAO,GAAG,KAAK,IAAI,aAAa,CAEtE"}