Skip to content

Commit 9e4a5ad

Browse files
author
Roberto Sora
committed
Update README.rst adding a bit about telemetry documentation
1 parent c2edca7 commit 9e4a5ad

File tree

1 file changed

+28
-2
lines changed

1 file changed

+28
-2
lines changed

README.rst

Lines changed: 28 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -495,12 +495,38 @@ Arduino Hardware specification. You can find more information in this
495495
`arduino/Arduino wiki
496496
page <https://github.com/arduino/Arduino/wiki/Arduino-IDE-1.5-3rd-party-Hardware-specification>`__
497497

498-
Using the gRPC interface
499-
------------------------
498+
Using the ``daemon`` mode and the gRPC interface
499+
------------------------------------------------
500+
501+
Arduino CLI can be launched as a gRPC server via the ``daemon`` command
500502

501503
The `client_example <./client_example>`__ folder contains a sample
502504
program that shows how to use gRPC interface of the CLI.
503505

506+
To provide observability for the gRPC server activities besides logs,
507+
the ``daemon`` mode activatesand exposes by default a `Prometheus <https://prometheus.io/>`__
508+
endpoint (at http://localhost:9090/metrics ) that can be fetched for
509+
telemetry data like:
510+
511+
.. code:: text
512+
513+
# TYPE daemon_compile counter
514+
daemon_compile{buildProperties="",exportFile="",fqbn="arduino:samd:mkr1000",installationID="ed6f1f22-1fbe-4b1f-84be-84d035b6369c",jobs="0",libraries="",preprocess="false",quiet="false",showProperties="false",sketchPath="5ff767c6fa5a91230f5cb4e267c889aa61489ab2c4f70f35f921f934c1462cb6",success="true",verbose="true",vidPid="",warnings=""} 1 1580385724726
515+
516+
# TYPE daemon_board_list counter
517+
daemon_board_list{installationID="ed6f1f22-1fbe-4b1f-84be-84d035b6369c",success="true"} 1 1580385724833
518+
519+
The telemetry settings are exposed via the ``telemetry`` section
520+
in the CLI configuration:
521+
522+
.. code:: yaml
523+
524+
telemetry:
525+
enabled: true
526+
addr: :9090
527+
pattern: /metrics
528+
529+
504530
.. |Tests passing| image:: https://github.com/Arduino/arduino-cli/workflows/test/badge.svg
505531
:target: https://github.com/Arduino/arduino-cli/actions?workflow=test
506532
.. |Nightly build| image:: https://github.com/Arduino/arduino-cli/workflows/nightly/badge.svg

0 commit comments

Comments
 (0)