@opentelemetry/instrumentation-http
Version:
OpenTelemetry instrumentation for `node:http` and `node:https` http client and server modules
239 lines • 9.29 kB
TypeScript
/**
* Specifies the category of synthetic traffic, such as tests or bots.
*
* @note This attribute **MAY** be derived from the contents of the `user_agent.original` attribute. Components that populate the attribute are responsible for determining what they consider to be synthetic bot or test traffic. This attribute can either be set for self-identification purposes, or on telemetry detected to be generated as a result of a synthetic request. This attribute is useful for distinguishing between genuine client traffic and synthetic traffic generated by bots or tests.
*
* @experimental This attribute is experimental and is subject to breaking changes in minor releases of `@opentelemetry/semantic-conventions`.
*/
export declare const ATTR_USER_AGENT_SYNTHETIC_TYPE: "user_agent.synthetic.type";
/**
* Enum value "bot" for attribute {@link ATTR_USER_AGENT_SYNTHETIC_TYPE}.
*/
export declare const USER_AGENT_SYNTHETIC_TYPE_VALUE_BOT: "bot";
/**
* Enum value "test" for attribute {@link ATTR_USER_AGENT_SYNTHETIC_TYPE}.
*/
export declare const USER_AGENT_SYNTHETIC_TYPE_VALUE_TEST: "test";
/**
* Deprecated, use `client.address` instead.
*
* @example "83.164.160.102"
*
* @experimental This attribute is experimental and is subject to breaking changes in minor releases of `@opentelemetry/semantic-conventions`.
*
* @deprecated Replaced by `client.address`.
*/
export declare const ATTR_HTTP_CLIENT_IP: "http.client_ip";
/**
* Deprecated, use `network.protocol.name` instead.
*
* @experimental This attribute is experimental and is subject to breaking changes in minor releases of `@opentelemetry/semantic-conventions`.
*
* @deprecated Replaced by `network.protocol.name`.
*/
export declare const ATTR_HTTP_FLAVOR: "http.flavor";
/**
* Deprecated, use one of `server.address`, `client.address` or `http.request.header.host` instead, depending on the usage.
*
* @example www.example.org
*
* @experimental This attribute is experimental and is subject to breaking changes in minor releases of `@opentelemetry/semantic-conventions`.
*
* @deprecated Replaced by one of `server.address`, `client.address` or `http.request.header.host`, depending on the usage.
*/
export declare const ATTR_HTTP_HOST: "http.host";
/**
* Deprecated, use `http.request.method` instead.
*
* @example GET
* @example POST
* @example HEAD
*
* @experimental This attribute is experimental and is subject to breaking changes in minor releases of `@opentelemetry/semantic-conventions`.
*
* @deprecated Replaced by `http.request.method`.
*/
export declare const ATTR_HTTP_METHOD: "http.method";
/**
* Deprecated, use `http.request.header.<key>` instead.
*
* @example 3495
*
* @experimental This attribute is experimental and is subject to breaking changes in minor releases of `@opentelemetry/semantic-conventions`.
*
* @deprecated Replaced by `http.request.header.<key>`.
*/
export declare const ATTR_HTTP_REQUEST_CONTENT_LENGTH: "http.request_content_length";
/**
* Deprecated, use `http.request.body.size` instead.
*
* @example 5493
*
* @experimental This attribute is experimental and is subject to breaking changes in minor releases of `@opentelemetry/semantic-conventions`.
*
* @deprecated Replaced by `http.request.body.size`.
*/
export declare const ATTR_HTTP_REQUEST_CONTENT_LENGTH_UNCOMPRESSED: "http.request_content_length_uncompressed";
/**
* Deprecated, use `http.response.header.<key>` instead.
*
* @example 3495
*
* @experimental This attribute is experimental and is subject to breaking changes in minor releases of `@opentelemetry/semantic-conventions`.
*
* @deprecated Replaced by `http.response.header.<key>`.
*/
export declare const ATTR_HTTP_RESPONSE_CONTENT_LENGTH: "http.response_content_length";
/**
* Deprecated, use `http.response.body.size` instead.
*
* @example 5493
*
* @experimental This attribute is experimental and is subject to breaking changes in minor releases of `@opentelemetry/semantic-conventions`.
*
* @deprecated Replace by `http.response.body.size`.
*/
export declare const ATTR_HTTP_RESPONSE_CONTENT_LENGTH_UNCOMPRESSED: "http.response_content_length_uncompressed";
/**
* Deprecated, use `url.scheme` instead.
*
* @example http
* @example https
*
* @experimental This attribute is experimental and is subject to breaking changes in minor releases of `@opentelemetry/semantic-conventions`.
*
* @deprecated Replaced by `url.scheme` instead.
*/
export declare const ATTR_HTTP_SCHEME: "http.scheme";
/**
* Deprecated, use `server.address` instead.
*
* @example example.com
*
* @experimental This attribute is experimental and is subject to breaking changes in minor releases of `@opentelemetry/semantic-conventions`.
*
* @deprecated Replaced by `server.address`.
*/
export declare const ATTR_HTTP_SERVER_NAME: "http.server_name";
/**
* Deprecated, use `http.response.status_code` instead.
*
* @example 200
*
* @experimental This attribute is experimental and is subject to breaking changes in minor releases of `@opentelemetry/semantic-conventions`.
*
* @deprecated Replaced by `http.response.status_code`.
*/
export declare const ATTR_HTTP_STATUS_CODE: "http.status_code";
/**
* Deprecated, use `url.path` and `url.query` instead.
*
* @example /search?q=OpenTelemetry#SemConv
*
* @experimental This attribute is experimental and is subject to breaking changes in minor releases of `@opentelemetry/semantic-conventions`.
*
* @deprecated Split to `url.path` and `url.query.
*/
export declare const ATTR_HTTP_TARGET: "http.target";
/**
* Deprecated, use `url.full` instead.
*
* @example https://www.foo.bar/search?q=OpenTelemetry#SemConv
*
* @experimental This attribute is experimental and is subject to breaking changes in minor releases of `@opentelemetry/semantic-conventions`.
*
* @deprecated Replaced by `url.full`.
*/
export declare const ATTR_HTTP_URL: "http.url";
/**
* Deprecated, use `user_agent.original` instead.
*
* @example CERN-LineMode/2.15 libwww/2.17b3
* @example Mozilla/5.0 (iPhone; CPU iPhone OS 14_7_1 like Mac OS X) AppleWebKit/605.1.15 (KHTML, like Gecko) Version/14.1.2 Mobile/15E148 Safari/604.1
*
* @experimental This attribute is experimental and is subject to breaking changes in minor releases of `@opentelemetry/semantic-conventions`.
*
* @deprecated Replaced by `user_agent.original`.
*/
export declare const ATTR_HTTP_USER_AGENT: "http.user_agent";
/**
* Deprecated, use `network.local.address`.
*
* @example "192.168.0.1"
*
* @experimental This attribute is experimental and is subject to breaking changes in minor releases of `@opentelemetry/semantic-conventions`.
*
* @deprecated Replaced by `network.local.address`.
*/
export declare const ATTR_NET_HOST_IP: "net.host.ip";
/**
* Deprecated, use `server.address`.
*
* @example example.com
*
* @experimental This attribute is experimental and is subject to breaking changes in minor releases of `@opentelemetry/semantic-conventions`.
*
* @deprecated Replaced by `server.address`.
*/
export declare const ATTR_NET_HOST_NAME: "net.host.name";
/**
* Deprecated, use `server.port`.
*
* @example 8080
*
* @experimental This attribute is experimental and is subject to breaking changes in minor releases of `@opentelemetry/semantic-conventions`.
*
* @deprecated Replaced by `server.port`.
*/
export declare const ATTR_NET_HOST_PORT: "net.host.port";
/**
* Deprecated, use `network.peer.address`.
*
* @example "127.0.0.1"
*
* @experimental This attribute is experimental and is subject to breaking changes in minor releases of `@opentelemetry/semantic-conventions`.
*
* @deprecated Replaced by `network.peer.address`.
*/
export declare const ATTR_NET_PEER_IP: "net.peer.ip";
/**
* Deprecated, use `server.address` on client spans and `client.address` on server spans.
*
* @example example.com
*
* @experimental This attribute is experimental and is subject to breaking changes in minor releases of `@opentelemetry/semantic-conventions`.
*
* @deprecated Replaced by `server.address` on client spans and `client.address` on server spans.
*/
export declare const ATTR_NET_PEER_NAME: "net.peer.name";
/**
* Deprecated, use `server.port` on client spans and `client.port` on server spans.
*
* @example 8080
*
* @experimental This attribute is experimental and is subject to breaking changes in minor releases of `@opentelemetry/semantic-conventions`.
*
* @deprecated Replaced by `server.port` on client spans and `client.port` on server spans.
*/
export declare const ATTR_NET_PEER_PORT: "net.peer.port";
/**
* Deprecated, use `network.transport`.
*
* @experimental This attribute is experimental and is subject to breaking changes in minor releases of `@opentelemetry/semantic-conventions`.
*
* @deprecated Replaced by `network.transport`.
*/
export declare const ATTR_NET_TRANSPORT: "net.transport";
/**
* Enum value "ip_tcp" for attribute {@link ATTR_NET_TRANSPORT}.
*/
export declare const NET_TRANSPORT_VALUE_IP_TCP: "ip_tcp";
/**
* Enum value "ip_udp" for attribute {@link ATTR_NET_TRANSPORT}.
*/
export declare const NET_TRANSPORT_VALUE_IP_UDP: "ip_udp";
/**
* Enum value "1.1" for attribute {@link ATTR_HTTP_FLAVOR}.
*/
export declare const HTTP_FLAVOR_VALUE_HTTP_1_1: "1.1";
//# sourceMappingURL=semconv.d.ts.map