Skip to content
This repository was archived by the owner on Sep 2, 2025. It is now read-only.

Commit b922051

Browse files
aurbiztondo-splunkaurbiztondo-splunk
committed
WIP
1 parent c400a1f commit b922051

File tree

1 file changed

+31
-77
lines changed

1 file changed

+31
-77
lines changed

‎gdi/opentelemetry/common-config/collector-common-config-grcp.rst‎

Lines changed: 31 additions & 77 deletions
Original file line numberDiff line numberDiff line change
@@ -4,33 +4,34 @@
44
Configure gRCP
55
*********************************************************************************
66

7-
gRPC exposes a variety of settings you can adjust within individual receivers or exporters of the Collector. For more information, refer to :ref:`Golang's gRCP documentation <https://pkg.go.dev/google.golang.org/grpc>`.
7+
gRPC exposes a variety of settings you can adjust within individual receivers or exporters of the Collector.
88

9-
Configure clients
10-
=============================================================================================
11-
12-
To configure clients in :ref:`exporters <otel-components-exporters>` use this settings:
13-
14-
* ``balancer_name``. Defaults: ``pick_first`` before version 0.103.0, ``round_robin`` for v0.103.0 or higher.
15-
16-
* Learn more at gRCP's :new-page:`Load Balancing README https://github.com/grpc/grpc-go/blob/master/examples/features/load_balancing/README.md`.
9+
For more details on the available settings refer to :new-page:`gRPC Configuration Settings <https://github.com/open-telemetry/opentelemetry-collector/tree/main/config/configgrpc>` in OTel's GitHub repo and :new-page:`Golang's gRCP documentation <https://pkg.go.dev/google.golang.org/grpc>`.
1710

18-
* ``compression``. Compression type. Vali values are ``gzip``, ``snappy``, ``zstd``, and ``none``.
11+
.. note::
12+
13+
To configure transport, see :ref:`collector-common-config-net`.
1914

20-
* ``endpoint``.: Valid value syntax available here
15+
Configure gRCP clients
16+
=============================================================================================
2117

22-
* ``tls``. See :ref:`collector-collector-common-config-tls`.
18+
.. note:: For more details see :new-page:`gRPC Configuration Settings https://github.com/open-telemetry/opentelemetry-collector/tree/main/config/configgrpc` in OTel's GitHub repo.
2319

24-
* ``headers``: name/value pairs added to the request
20+
To configure gRCP clients in :ref:`exporters <otel-components-exporters>` use these settings:
2521

26-
keepalive
27-
permit_without_stream
28-
time
29-
timeout
30-
read_buffer_size
31-
write_buffer_size
32-
auth
33-
Please note that per_rpc_auth which allows the credentials to send for every RPC is now moved to become an extension. Note that this feature isn't about sending the headers only during the initial connection as an authorization header under the headers would do: this is sent for every RPC performed during an established connection.
22+
* ``auth``. See :ref:`collector-common-config-auth`
23+
* ``balancer_name``
24+
* Defaults: ``pick_first`` before version 0.103.0, ``round_robin`` for v0.103.0 or higher
25+
* Learn more at gRCP's :new-page:`Load Balancing README https://github.com/grpc/grpc-go/blob/master/examples/features/load_balancing/README.md`.
26+
* ``compression``.
27+
* Compression type valid values are ``gzip``, ``snappy``, ``zstd``, and ``none``
28+
* ``endpoint``
29+
* For valid syntax see :new-page:`gRPC Name Resolution <https://github.com/grpc/grpc/blob/master/doc/naming.md>`.
30+
* ``headers``
31+
* ``keepalive``
32+
* ``read_buffer_size``
33+
* ``tls``. See :ref:`collector-common-config-tls`.
34+
* ``write_buffer_size``
3435

3536
For example:
3637

@@ -49,68 +50,21 @@ For example:
4950
test1: "value1"
5051
"test 2": "value 2"
5152
52-
Compression Comparison
53-
configgrpc_benchmark_test.go contains benchmarks comparing the supported compression algorithms. It performs compression using gzip, zstd, and snappy compression on small, medium, and large sized log, trace, and metric payloads. Each test case outputs the uncompressed payload size, the compressed payload size, and the average nanoseconds spent on compression.
54-
55-
The following table summarizes the results, including some additional columns computed from the raw data. The benchmarks were performed on an AWS m5.large EC2 instance with an Intel(R) Xeon(R) Platinum 8259CL CPU @ 2.50GHz.
56-
57-
Request Compressor Raw Bytes Compressed bytes Compression ratio Ns / op Mb compressed / second Mb saved / second
58-
lg_log_request gzip 5150 262 19.66 49231 104.61 99.29
59-
lg_metric_request gzip 6800 201 33.83 51816 131.23 127.35
60-
lg_trace_request gzip 9200 270 34.07 65174 141.16 137.02
61-
md_log_request gzip 363 268 1.35 37609 9.65 2.53
62-
md_metric_request gzip 320 145 2.21 30141 10.62 5.81
63-
md_trace_request gzip 451 288 1.57 38270 11.78 4.26
64-
sm_log_request gzip 166 168 0.99 30511 5.44 -0.07
65-
sm_metric_request gzip 185 142 1.30 29055 6.37 1.48
66-
sm_trace_request gzip 233 205 1.14 33466 6.96 0.84
67-
lg_log_request snappy 5150 475 10.84 1915 2,689.30 2,441.25
68-
lg_metric_request snappy 6800 466 14.59 2266 3,000.88 2,795.23
69-
lg_trace_request snappy 9200 644 14.29 3281 2,804.02 2,607.74
70-
md_log_request snappy 363 300 1.21 770.0 471.43 81.82
71-
md_metric_request snappy 320 162 1.98 588.6 543.66 268.43
72-
md_trace_request snappy 451 330 1.37 907.7 496.86 133.30
73-
sm_log_request snappy 166 184 0.90 551.8 300.83 -32.62
74-
sm_metric_request snappy 185 154 1.20 526.3 351.51 58.90
75-
sm_trace_request snappy 233 251 0.93 682.1 341.59 -26.39
76-
lg_log_request zstd 5150 223 23.09 17998 286.14 273.75
77-
lg_metric_request zstd 6800 144 47.22 14289 475.89 465.81
78-
lg_trace_request zstd 9200 208 44.23 17160 536.13 524.01
79-
md_log_request zstd 363 261 1.39 11216 32.36 9.09
80-
md_metric_request zstd 320 145 2.21 9318 34.34 18.78
81-
md_trace_request zstd 451 301 1.50 12583 35.84 11.92
82-
sm_log_request zstd 166 165 1.01 12482 13.30 0.08
83-
sm_metric_request zstd 185 139 1.33 8824 20.97 5.21
84-
sm_trace_request zstd 233 203 1.15 10134 22.99 2.96
85-
Compression ratios will vary in practice as they are highly dependent on the data's information entropy. Compression rates are dependent on the speed of the CPU, and the size of payloads being compressed: smaller payloads compress at slower rates relative to larger payloads, which are able to amortize fixed computation costs over more bytes.
86-
87-
gzip is the only required compression algorithm required for OTLP servers, and is a natural first choice. It is not as fast as snappy, but achieves better compression ratios and has reasonable performance. If your collector is CPU bound and your OTLP server supports it, you may benefit from using snappy compression. If your collector is CPU bound and has a very fast network link, you may benefit from disabling compression, which is the default.
88-
8953
Server configuration
9054
=============================================================================================
9155

92-
.. note::
93-
94-
To configure transport, see :ref:`collector-common-config-net`.
56+
.. note:: For more details see :new-page:`gRPC Configuration Settings https://github.com/open-telemetry/opentelemetry-collector/tree/main/config/configgrpc` in OTel's GitHub repo.
9557

9658
To configure servers in :ref:`collector receivers <otel-components-receivers>` use these settings:
9759

98-
* keepalive
99-
* enforcement_policy
100-
* min_time
101-
* permit_without_stream
102-
* server_parameters
103-
* max_connection_age
104-
* max_connection_age_grace
105-
* max_connection_idle
106-
* time
107-
* timeout
108-
* max_concurrent_streams
109-
* max_recv_msg_size_mib
110-
* read_buffer_size
111-
* tls
112-
* write_buffer_size
113-
* auth
60+
* ``auth``. See :ref:`collector-common-config-auth`
61+
* ``keepalive``
62+
* ``max_concurrent_streams``
63+
* ``max_recv_msg_size_mib``
64+
* ``read_buffer_size``
65+
* ``tls``. See :ref:`collector-common-config-tls`
66+
* ``write_buffer_size``
67+
11468

11569

11670

0 commit comments

Comments
 (0)