otelsdk/_pkgdown.yml at main · r-lib/otelsdk · 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
url: https://otelsdk.r-lib.org

template:
  package: tidytemplate
  bootstrap: 5

  includes:
    in_header: |
      <script src="https://cdn.jsdelivr.net/gh/posit-dev/supported-by-posit/js/badge.min.js" data-max-height="43" data-light-bg="#666f76" data-light-fg="#f9f9f9"></script>
      <script defer data-domain="all.r-lib.org,all.tidyverse.org" src="https://plausible.io/js/plausible.js"></script>

development:
  mode: auto

navbar:
  structure:
    left: [gettingstarted, reference]
    right: [search, news, github]
  components:
    gettingstarted:
      text: Getting Started
      menu:
        - text: Instrumenting R Packages (otel package)
          href: https://otel.r-lib.org/reference/gettingstarted.html
        - text: Collecting Telemetry Data
          href: reference/collecting.html

reference:
- title: Other Documentation
  desc: |
    This is the reference manual of the otelsdk package. Other forms of
    documentation:

    * [Getting Started](https://otel.r-lib.org/reference/gettingstarted.html),
      a tutorial and cookbook for instrumentation.
    * [Collecting telemetry data](../reference/collecting.html), a tutorial
      and cookbook on telemetry data collection.

- title: Configuration
- contents:
  - "Environment Variables"
  - "Time Interval Options"
  - "File Size Options"

- title: Traces
- contents:
  - starts_with("tracer_provider_")

- title: Logs
- contents:
  - starts_with("logger_provider_")

- title: Metrics
- contents:
  - starts_with("meter_provider_")

- title: Utility functions
- contents:
  - with_otel_record

- title: internal
  contents:
  - collecting