otelProfiling/mkdocs.yaml at master · isItObservable/otelProfiling · 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
# MkDocs Configuration
# Save as: mkdocs.yml

site_name: OpenTelemetry Profile Data Structure
site_description: Complete guide to understanding OpenTelemetry profiling data schema
site_author: Your Name
theme:
  name: material
  palette:
    - scheme: default
      primary: deep purple
      accent: purple
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    - scheme: slate
      primary: deep purple
      accent: purple
      toggle:
        icon: material/brightness-4
        name: Switch to light mode
  features:
    - navigation.tabs
    - navigation.sections
    - navigation.expand
    - navigation.top
    - toc.integrate
    - search.suggest
    - search.highlight
    - content.tabs.link
    - content.code.annotation
    - content.code.copy
  icon:
    repo: fontawesome/brands/github

repo_url: https://github.com/open-telemetry/opentelemetry-proto-profile
repo_name: opentelemetry-proto-profile

markdown_extensions:
  - pymdownx.highlight:
      anchor_linenums: true
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - admonition
  - pymdownx.arithmatex:
      generic: true
  - footnotes
  - pymdownx.details
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
  - pymdownx.mark
  - attr_list
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg
  - pymdownx.tabbed:
      alternate_style: true
  - md_in_html
  - tables

nav:
  - Home: index.md
  - Concepts:
      - What is Profiling?: concepts/what-is-profiling.md
      - Profiling Protocols: concepts/profiling-protocols.md
      - pprof vs OTLP: comparison/pprof-vs-otlp.md
  - Data Structure:
  #    - Overview: structure/overview.md
      - Schema Details: structure/hierarchy.md
   #   - Components: structure/components.md
  - Setup & Configuration:
      - Kubernetes with eBPF: setup/kubernetes-ebpf.md
    #  - Collector Configuration: setup/collector-config.md
    #  - Runtime Profilers: setup/runtime-profilers.md
  - Processing:
      - OTTL Support: processing/ottl-support.md
      - Processors & Connectors: processing/processors-connectors.md
      - signal2metric Deep Dive: processing/signal2metric.md
  - Real Examples:
      - Debug Output: examples/debug-output.md
     # - Sample Analysis: examples/sample-analysis.md
      #- Multi-Runtime: examples/multi-runtime.md
  - Use Cases:
      - CPU Profiling: usecases/cpu-profiling.md
      #- Memory Analysis: usecases/memory-analysis.md
     # - Trace Correlation: usecases/trace-correlation.md
  - Reference:
      - Field Reference: reference/fields.md
     # - Semantic Conventions: reference/semconv.md

plugins:
  - search
  - minify:
      minify_html: true

extra:
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/open-telemetry
    - icon: fontawesome/brands/slack
      link: https://cloud-native.slack.com/archives/C03PQ4T1P1L

extra_css:
  - stylesheets/extra.css

copyright: Copyright &copy; 2024 OpenTelemetry Authors