opentelemetry-collector-contrib/receiver/httpcheckreceiver/metadata.yaml at main · open-telemetry/opentelemetry-collector-contrib · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
display_name: HTTP Check Receiver
type: httpcheck

description: |
  The HTTP Check Receiver can be used for synthetic checks against HTTP endpoints.

status:
  class: receiver
  stability:
    alpha: [metrics]
  distributions: [contrib, k8s]
  warnings: []
  codeowners:
    active: [VenuEmmadi]
    emeritus: [codeboten]
    seeking_new: true

resource_attributes:

attributes:
  error.message:
    description: Error message recorded during check
    type: string
  http.method:
    description: HTTP request method
    type: string
  http.status_class:
    description: HTTP response status class
    type: string
  http.status_code:
    description: HTTP response status code
    type: int
  http.tls.cn:
    description: The commonName in the subject of the certificate.
    type: string
  http.tls.issuer:
    description: The entity that issued the certificate.
    type: string
  http.tls.san:
    description: The Subject Alternative Name of the certificate.
    type: slice
  http.url:
    description: Full HTTP request URL.
    type: string
  network.transport:
    description: OSI transport layer or inter-process communication method.
    type: string
  validation.type:
    description: Type of validation performed (contains, json_path, size, regex)
    type: string

metrics:
  httpcheck.client.connection.duration:
    description: Time spent establishing TCP connection to the endpoint.
    enabled: false
    stability: development
    gauge:
      value_type: int
    unit: ms
    attributes: [http.url, network.transport]
  httpcheck.client.request.duration:
    description: Time spent sending the HTTP request to the endpoint.
    enabled: false
    stability: development
    gauge:
      value_type: int
    unit: ms
    attributes: [http.url]
  httpcheck.dns.lookup.duration:
    description: Time spent performing DNS lookup for the endpoint.
    enabled: false
    stability: development
    gauge:
      value_type: int
    unit: ms
    attributes: [http.url]
  httpcheck.duration:
    description: Measures the duration of the HTTP check.
    enabled: true
    stability: development
    gauge:
      value_type: int
    unit: ms
    attributes: [http.url]
  httpcheck.error:
    description: Records errors occurring during HTTP check.
    enabled: true
    stability: development
    sum:
      value_type: int
      aggregation_temporality: cumulative
      monotonic: false
    unit: "{error}"
    attributes: [http.url, error.message]
  httpcheck.response.duration:
    description: Time spent receiving the HTTP response from the endpoint.
    enabled: false
    stability: development
    gauge:
      value_type: int
    unit: ms
    attributes: [http.url]
  httpcheck.response.size:
    description: Size of response body in bytes.
    enabled: false
    stability: development
    gauge:
      value_type: int
    unit: "By"
    attributes: [http.url]
  httpcheck.status:
    description: 1 if the check resulted in status_code matching the status_class, otherwise 0.
    enabled: true
    stability: development
    sum:
      value_type: int
      aggregation_temporality: cumulative
      monotonic: false
    unit: "1"
    attributes: [http.url, http.status_code, http.method, http.status_class]
  httpcheck.tls.cert_remaining:
    description: Time in seconds until certificate expiry, as specified by `NotAfter` field in the x.509 certificate. Negative values represent time in seconds since expiration.
    enabled: false
    stability: development
    gauge:
      value_type: int
    unit: "s"
    attributes: [http.url, http.tls.issuer, http.tls.cn, http.tls.san]
  httpcheck.tls.handshake.duration:
    description: Time spent performing TLS handshake with the endpoint.
    enabled: false
    stability: development
    gauge:
      value_type: int
    unit: ms
    attributes: [http.url]
  httpcheck.validation.failed:
    description: Number of response validations that failed.
    enabled: false
    stability: development
    sum:
      value_type: int
      aggregation_temporality: cumulative
      monotonic: false
    unit: "{validation}"
    attributes: [http.url, validation.type]
  httpcheck.validation.passed:
    description: Number of response validations that passed.
    enabled: false
    stability: development
    sum:
      value_type: int
      aggregation_temporality: cumulative
      monotonic: false
    unit: "{validation}"
    attributes: [http.url, validation.type]