Skip to content

Commit 165b076

Browse files
committed
reverting docs
Signed-off-by: Andreas Gkizas <[email protected]>
1 parent d20d19d commit 165b076

File tree

3 files changed

+31
-43
lines changed

3 files changed

+31
-43
lines changed

receiver/doc.go

Lines changed: 7 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -9,24 +9,13 @@
99
//
1010
// # Error Handling
1111
//
12-
// The nextConsumer.Consume*() function may return an error to indicate that the data
13-
// was not accepted. There are 2 types of possible errors: Permanent and non-Permanent.
14-
// The receiver must check the type of the error using IsPermanent() helper.
15-
//
16-
// If the error is Permanent, then the nextConsumer.Consume*() call should not be
17-
// retried with the same data. This typically happens when the data cannot be
18-
// serialized by the exporter that is attached to the pipeline or when the destination
19-
// refuses the data because it cannot decode it. The receiver must indicate to
20-
// the source from which it received the data that the received data was bad, if the
21-
// receiving protocol allows to do that. In case of OTLP/HTTP for example, this means
22-
// that HTTP 400 response is returned to the sender.
23-
//
24-
// If the error is non-Permanent then the nextConsumer.Consume*() call should be retried
25-
// with the same data. This may be done by the receiver itself, however typically it is
26-
// done by the original sender, after the receiver returns a response to the sender
27-
// indicating that the Collector is currently overloaded and the request must be
28-
// retried. In case of OTLP/HTTP for example, this means that HTTP 429 or 503 response
29-
// is returned.
12+
// The nextConsumer.Consume*() function may return an error to indicate that the data was not
13+
// accepted. This error should be handled as documented in the consumererror package.
14+
//
15+
// Depending on the error type, the receiver must indicate to the source from which it received the
16+
// data the type of error in a protocol-dependent way, if that is supported by the receiving protocol.
17+
// For example, a receiver for the OTLP/HTTP protocol would use the HTTP status codes as defined in
18+
// the OTLP specification.
3019
//
3120
// # Acknowledgment and Checkpointing
3221
//

receiver/receiverhelper/documentation.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -8,19 +8,19 @@ The following telemetry is emitted by this component.
88

99
### otelcol_receiver_accepted_log_records
1010

11-
The number of log records successfully accepted by the receiver.
11+
Number of log records successfully pushed into the pipeline. [alpha]
1212

1313
| Unit | Metric Type | Value Type | Monotonic |
1414
| ---- | ----------- | ---------- | --------- |
1515
| {records} | Sum | Int | true |
1616

1717
### otelcol_receiver_accepted_metric_points
1818

19-
The number of metric points successfully accepted by the receiver.
19+
Number of metric points successfully pushed into the pipeline. [alpha]
2020

2121
| Unit | Metric Type | Value Type | Monotonic |
2222
| ---- | ----------- | ---------- | --------- |
23-
| {points} | Sum | Int | true |
23+
| {datapoints} | Sum | Int | true |
2424

2525
### otelcol_receiver_accepted_spans
2626

@@ -56,19 +56,19 @@ The number of spans that failed to be processed by the receiver due to internal
5656

5757
### otelcol_receiver_refused_log_records
5858

59-
The number of log records refused by the receiver.
59+
Number of log records that could not be pushed into the pipeline. [alpha]
6060

6161
| Unit | Metric Type | Value Type | Monotonic |
6262
| ---- | ----------- | ---------- | --------- |
6363
| {records} | Sum | Int | true |
6464

6565
### otelcol_receiver_refused_metric_points
6666

67-
The number of metric points refused by the receiver.
67+
Number of metric points that could not be pushed into the pipeline. [alpha]
6868

6969
| Unit | Metric Type | Value Type | Monotonic |
7070
| ---- | ----------- | ---------- | --------- |
71-
| {points} | Sum | Int | true |
71+
| {datapoints} | Sum | Int | true |
7272

7373
### otelcol_receiver_refused_spans
7474

receiver/receiverhelper/metadata.yaml

Lines changed: 18 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -4,78 +4,77 @@ status:
44
disable_codecov_badge: true
55
class: pkg
66
stability:
7-
stable: [metrics, traces, logs]
7+
beta: [metrics, traces, logs]
88
telemetry:
99
metrics:
1010
receiver_accepted_spans:
1111
enabled: true
12-
description: Number of spans successfully pushed into the pipeline. [alpha]
12+
stability:
13+
level: alpha
14+
description: Number of spans successfully pushed into the pipeline.
1315
unit: "{spans}"
1416
sum:
1517
value_type: int
1618
monotonic: true
17-
aggregation_temporality: cumulative
1819
receiver_refused_spans:
1920
enabled: true
20-
description: Number of spans that could not be pushed into the pipeline. [alpha]
21+
description: Number of spans that could not be pushed into the pipeline.
2122
unit: "{spans}"
2223
sum:
2324
value_type: int
2425
monotonic: true
25-
aggregation_temporality: cumulative
2626
receiver_internal_errors_spans:
2727
enabled: true
2828
description: The number of spans that failed to be processed by the receiver due to internal errors.
2929
unit: "{spans}"
3030
sum:
3131
value_type: int
3232
monotonic: true
33-
aggregation_temporality: cumulative
3433
receiver_accepted_metric_points:
34+
stability:
35+
level: alpha
3536
enabled: true
36-
description: The number of metric points successfully accepted by the receiver.
37-
unit: "{points}"
37+
description: Number of metric points successfully pushed into the pipeline.
38+
unit: "{datapoints}"
3839
sum:
3940
value_type: int
4041
monotonic: true
41-
aggregation_temporality: cumulative
4242
receiver_refused_metric_points:
4343
enabled: true
44-
description: The number of metric points refused by the receiver.
45-
unit: "{points}"
44+
description: Number of metric points that could not be pushed into the pipeline.
45+
unit: "{datapoints}"
4646
sum:
4747
value_type: int
4848
monotonic: true
49-
aggregation_temporality: cumulative
5049
receiver_internal_errors_metric_points:
5150
enabled: true
5251
description: The number of metric points that failed to be processed by the receiver due to internal errors.
53-
unit: "{points}"
52+
unit: "{datapoints}"
5453
sum:
5554
value_type: int
5655
monotonic: true
57-
aggregation_temporality: cumulative
5856
receiver_accepted_log_records:
5957
enabled: true
60-
description: The number of log records successfully accepted by the receiver.
58+
stability:
59+
level: alpha
60+
description: Number of log records successfully pushed into the pipeline.
6161
unit: "{records}"
6262
sum:
6363
value_type: int
6464
monotonic: true
65-
aggregation_temporality: cumulative
6665
receiver_refused_log_records:
6766
enabled: true
68-
description: The number of log records refused by the receiver.
67+
stability:
68+
level: alpha
69+
description: Number of log records that could not be pushed into the pipeline.
6970
unit: "{records}"
7071
sum:
7172
value_type: int
7273
monotonic: true
73-
aggregation_temporality: cumulative
7474
receiver_internal_errors_log_records:
7575
enabled: true
7676
description: The number of log records that failed to be processed by the receiver due to internal errors.
7777
unit: "{records}"
7878
sum:
7979
value_type: int
8080
monotonic: true
81-
aggregation_temporality: cumulative

0 commit comments

Comments
 (0)