|
| 1 | +/* |
| 2 | + * Copyright The OpenTelemetry Authors |
| 3 | + * |
| 4 | + * Licensed under the Apache License, Version 2.0 (the "License"); |
| 5 | + * you may not use this file except in compliance with the License. |
| 6 | + * You may obtain a copy of the License at |
| 7 | + * |
| 8 | + * https://www.apache.org/licenses/LICENSE-2.0 |
| 9 | + * |
| 10 | + * Unless required by applicable law or agreed to in writing, software |
| 11 | + * distributed under the License is distributed on an "AS IS" BASIS, |
| 12 | + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| 13 | + * See the License for the specific language governing permissions and |
| 14 | + * limitations under the License. |
| 15 | + */ |
| 16 | + |
| 17 | +export enum OtlpSpanKind { |
| 18 | + UNSPECIFIED = 0, |
| 19 | + INTERNAL = 1, |
| 20 | + SERVER = 2, |
| 21 | + CLIENT = 3, |
| 22 | + PRODUCER = 4, |
| 23 | + CONSUMER = 5, |
| 24 | +} |
| 25 | + |
| 26 | +/** Properties of a KeyValueList. */ |
| 27 | +interface IKeyValueList { |
| 28 | + /** KeyValueList values */ |
| 29 | + values: IKeyValue[]; |
| 30 | +} |
| 31 | + |
| 32 | +/** Properties of an ArrayValue. */ |
| 33 | +interface IArrayValue { |
| 34 | + /** ArrayValue values */ |
| 35 | + values: IAnyValue[]; |
| 36 | +} |
| 37 | + |
| 38 | +/** Properties of an AnyValue. */ |
| 39 | +interface IAnyValue { |
| 40 | + /** AnyValue stringValue */ |
| 41 | + stringValue?: string | null; |
| 42 | + /** AnyValue boolValue */ |
| 43 | + boolValue?: boolean | null; |
| 44 | + /** AnyValue intValue */ |
| 45 | + intValue?: number | null; |
| 46 | + /** AnyValue doubleValue */ |
| 47 | + doubleValue?: number | null; |
| 48 | + /** AnyValue arrayValue */ |
| 49 | + arrayValue?: IArrayValue; |
| 50 | + /** AnyValue kvlistValue */ |
| 51 | + kvlistValue?: IKeyValueList; |
| 52 | + /** AnyValue bytesValue */ |
| 53 | + bytesValue?: Uint8Array; |
| 54 | +} |
| 55 | + |
| 56 | +/** Properties of a KeyValue. */ |
| 57 | +interface IKeyValue { |
| 58 | + /** KeyValue key */ |
| 59 | + key: string; |
| 60 | + /** KeyValue value */ |
| 61 | + value: IAnyValue; |
| 62 | +} |
| 63 | + |
| 64 | +/** Properties of an InstrumentationScope. */ |
| 65 | +export interface IInstrumentationScope { |
| 66 | + /** InstrumentationScope name */ |
| 67 | + name: string; |
| 68 | + /** InstrumentationScope version */ |
| 69 | + version?: string; |
| 70 | + /** InstrumentationScope attributes */ |
| 71 | + attributes?: IKeyValue[]; |
| 72 | + /** InstrumentationScope droppedAttributesCount */ |
| 73 | + droppedAttributesCount?: number; |
| 74 | +} |
| 75 | + |
| 76 | +/** Properties of a Resource. */ |
| 77 | +export interface IResource { |
| 78 | + /** Resource attributes */ |
| 79 | + attributes: IKeyValue[]; |
| 80 | + /** Resource droppedAttributesCount */ |
| 81 | + droppedAttributesCount: number; |
| 82 | +} |
| 83 | + |
| 84 | +interface LongBits { |
| 85 | + low: number; |
| 86 | + high: number; |
| 87 | +} |
| 88 | + |
| 89 | +type Fixed64 = LongBits | string | number; |
| 90 | + |
| 91 | +/** Properties of an Event. */ |
| 92 | +interface IEvent { |
| 93 | + /** Event timeUnixNano */ |
| 94 | + timeUnixNano: Fixed64; |
| 95 | + /** Event name */ |
| 96 | + name: string; |
| 97 | + /** Event attributes */ |
| 98 | + attributes: IKeyValue[]; |
| 99 | + /** Event droppedAttributesCount */ |
| 100 | + droppedAttributesCount: number; |
| 101 | +} |
| 102 | + |
| 103 | +/** Properties of a Link. */ |
| 104 | +interface ILink { |
| 105 | + /** Link traceId */ |
| 106 | + traceId: string | Uint8Array; |
| 107 | + /** Link spanId */ |
| 108 | + spanId: string | Uint8Array; |
| 109 | + /** Link traceState */ |
| 110 | + traceState?: string; |
| 111 | + /** Link attributes */ |
| 112 | + attributes: IKeyValue[]; |
| 113 | + /** Link droppedAttributesCount */ |
| 114 | + droppedAttributesCount: number; |
| 115 | +} |
| 116 | + |
| 117 | +/** Properties of a Status. */ |
| 118 | +interface IStatus { |
| 119 | + /** Status message */ |
| 120 | + message?: string; |
| 121 | + /** Status code */ |
| 122 | + code: EStatusCode; |
| 123 | +} |
| 124 | + |
| 125 | +/** StatusCode enum. */ |
| 126 | +const enum EStatusCode { |
| 127 | + /** The default status. */ |
| 128 | + STATUS_CODE_UNSET = 0, |
| 129 | + /** The Span has been evaluated by an Application developer or Operator to have completed successfully. */ |
| 130 | + STATUS_CODE_OK = 1, |
| 131 | + /** The Span contains an error. */ |
| 132 | + STATUS_CODE_ERROR = 2, |
| 133 | +} |
| 134 | + |
| 135 | +/** Properties of a Span. */ |
| 136 | +export interface ISpan { |
| 137 | + /** Span traceId */ |
| 138 | + traceId: string | Uint8Array; |
| 139 | + /** Span spanId */ |
| 140 | + spanId: string | Uint8Array; |
| 141 | + /** Span traceState */ |
| 142 | + traceState?: string | null; |
| 143 | + /** Span parentSpanId */ |
| 144 | + parentSpanId?: string | Uint8Array; |
| 145 | + /** Span name */ |
| 146 | + name: string; |
| 147 | + /** Span kind */ |
| 148 | + kind: OtlpSpanKind; |
| 149 | + /** Span startTimeUnixNano */ |
| 150 | + startTimeUnixNano: Fixed64; |
| 151 | + /** Span endTimeUnixNano */ |
| 152 | + endTimeUnixNano: Fixed64; |
| 153 | + /** Span attributes */ |
| 154 | + attributes: IKeyValue[]; |
| 155 | + /** Span droppedAttributesCount */ |
| 156 | + droppedAttributesCount: number; |
| 157 | + /** Span events */ |
| 158 | + events: IEvent[]; |
| 159 | + /** Span droppedEventsCount */ |
| 160 | + droppedEventsCount: number; |
| 161 | + /** Span links */ |
| 162 | + links: ILink[]; |
| 163 | + /** Span droppedLinksCount */ |
| 164 | + droppedLinksCount: number; |
| 165 | + /** Span status */ |
| 166 | + status: IStatus; |
| 167 | +} |
0 commit comments