mkdocs.yml

site_name: Atlas Docs
site_url: 'https://netflix.github.io/atlas-docs/'
repo_url: 'https://github.com/Netflix/atlas-docs'
edit_uri: edit/main/docs/
strict: True

nav:
- Home:
  - Introduction: index.md
  - Overview: overview.md
  - Getting Started: getting-started.md
- Core Concepts:
  - Time Series: concepts/time-series.md
  - Normalization: concepts/normalization.md
  - Consolidation: concepts/consolidation.md
  - Naming: concepts/naming.md
- API:
  - Graph:
    - Introduction: api/graph/graph.md
    - Basics: api/graph/basics.md
    - Examples: api/graph/examples.md
    - Anonymization: api/graph/anonymization.md
    - Axis Bounds: api/graph/axis-bounds.md
    - Axis Scale: api/graph/axis-scale.md
    - Color Blindness: api/graph/vision.md
    - Color Palettes: api/graph/color-palettes.md
    - Heatmap: api/graph/heatmap.md
    - Layout: api/graph/layout.md
    - Legends: api/graph/legends.md
    - Line Attributes: api/graph/line-attributes.md
    - Line Styles: api/graph/line-styles.md
    - Multi Y Axis: api/graph/multi-y.md
    - Output Formats: api/graph/outputs.md
    - Tick Labels: api/graph/tick.md
    - Time Shift: api/graph/time-shift.md
    - Time Zones: api/graph/time-zone.md
  - Tags: api/tags.md
  - Time Parameters: api/time-parameters.md
- Stack Language:
  - Tutorial: asl/tutorial.md
  - Alerting Expressions: asl/alerting-expressions.md
  - Alerting Philosophy: asl/alerting-philosophy.md
  - Double Exponential Smoothing: asl/des.md
  - Reference:
    - Choosing:
      - and: asl/ref/and.md
      - contains: asl/ref/contains.md
      - ends: asl/ref/ends.md
      - eq: asl/ref/eq.md
      - 'false': asl/ref/false.md
      - ge: asl/ref/ge.md
      - gt: asl/ref/gt.md
      - has: asl/ref/has.md
      - in: asl/ref/in.md
      - le: asl/ref/le.md
      - lt: asl/ref/lt.md
      - not: asl/ref/not.md
      - or: asl/ref/or.md
      - re: asl/ref/re.md
      - reic: asl/ref/reic.md
      - starts: asl/ref/starts.md
      - 'true': asl/ref/true.md
    - Aggregation:
      - avg: asl/ref/avg.md
      - by: asl/ref/by.md
      - cf-avg: asl/ref/cf-avg.md
      - cf-max: asl/ref/cf-max.md
      - cf-min: asl/ref/cf-min.md
      - cf-sum: asl/ref/cf-sum.md
      - count: asl/ref/count.md
      - max: asl/ref/max.md
      - min: asl/ref/min.md
      - sum: asl/ref/sum.md
    - Math:
      - abs: asl/ref/abs.md
      - add: asl/ref/add.md
      - and: asl/ref/and.md
      - as: asl/ref/as.md
      - avg: asl/ref/avg.md
      - bottomk: asl/ref/bottomk.md
      - bottomk-others-avg: asl/ref/bottomk-others-avg.md
      - bottomk-others-max: asl/ref/bottomk-others-max.md
      - bottomk-others-min: asl/ref/bottomk-others-min.md
      - bottomk-others-sum: asl/ref/bottomk-others-sum.md
      - by: asl/ref/by.md
      - cg: asl/ref/cg.md
      - clamp-max: asl/ref/clamp-max.md
      - clamp-min: asl/ref/clamp-min.md
      - const: asl/ref/const.md
      - count: asl/ref/count.md
      - cq: asl/ref/cq.md
      - delay: asl/ref/delay.md
      - derivative: asl/ref/derivative.md
      - des: asl/ref/des.md
      - des-epic-signal: asl/ref/des-epic-signal.md
      - des-fast: asl/ref/des-fast.md
      - des-simple: asl/ref/des-simple.md
      - des-slow: asl/ref/des-slow.md
      - des-slower: asl/ref/des-slower.md
      - dist-avg: asl/ref/dist-avg.md
      - dist-max: asl/ref/dist-max.md
      - dist-stddev: asl/ref/dist-stddev.md
      - div: asl/ref/div.md
      - eureka-avg: asl/ref/eureka-avg.md
      - fadd: asl/ref/fadd.md
      - fdiv: asl/ref/fdiv.md
      - filter: asl/ref/filter.md
      - fmul: asl/ref/fmul.md
      - fsub: asl/ref/fsub.md
      - ge: asl/ref/ge.md
      - gt: asl/ref/gt.md
      - integral: asl/ref/integral.md
      - le: asl/ref/le.md
      - lt: asl/ref/lt.md
      - max: asl/ref/max.md
      - median: asl/ref/median.md
      - mul: asl/ref/mul.md
      - min: asl/ref/min.md
      - neg: asl/ref/neg.md
      - node-avg: asl/ref/node-avg.md
      - offset: asl/ref/offset.md
      - or: asl/ref/or.md
      - pct: asl/ref/pct.md
      - per-step: asl/ref/per-step.md
      - percentiles: asl/ref/percentiles.md
      - pow: asl/ref/pow.md
      - random: asl/ref/random.md
      - rolling-count: asl/ref/rolling-count.md
      - rolling-max: asl/ref/rolling-max.md
      - rolling-mean: asl/ref/rolling-mean.md
      - rolling-min: asl/ref/rolling-min.md
      - rolling-sum: asl/ref/rolling-sum.md
      - sdes: asl/ref/sdes.md
      - sdes-fast: asl/ref/sdes-fast.md
      - sdes-simple: asl/ref/sdes-simple.md
      - sdes-slow: asl/ref/sdes-slow.md
      - sdes-slower: asl/ref/sdes-slower.md
      - sqrt: asl/ref/sqrt.md
      - srandom: asl/ref/srandom.md
      - stat: asl/ref/stat.md
      - stat-avg: asl/ref/stat-avg.md
      - stat-count: asl/ref/stat-count.md
      - stat-last: asl/ref/stat-last.md
      - stat-max: asl/ref/stat-max.md
      - stat-min: asl/ref/stat-min.md
      - stat-total: asl/ref/stat-total.md
      - stddev: asl/ref/stddev.md
      - sub: asl/ref/sub.md
      - sum: asl/ref/sum.md
      - time: asl/ref/time.md
      - time-span: asl/ref/time-span.md
      - topk: asl/ref/topk.md
      - topk-others-avg: asl/ref/topk-others-avg.md
      - topk-others-max: asl/ref/topk-others-max.md
      - topk-others-min: asl/ref/topk-others-min.md
      - topk-others-sum: asl/ref/topk-others-sum.md
    - Presentation:
      - alpha: asl/ref/alpha.md
      - area: asl/ref/area.md
      - axis: asl/ref/axis.md
      - color: asl/ref/color.md
      - decode: asl/ref/decode.md
      - des-epic-viz: asl/ref/des-epic-viz.md
      - filter: asl/ref/filter.md
      - head: asl/ref/head.md
      - heatmap: asl/ref/heatmap.md
      - legend: asl/ref/legend.md
      - limit: asl/ref/limit.md
      - line: asl/ref/line.md
      - ls: asl/ref/ls.md
      - lw: asl/ref/lw.md
      - palette: asl/ref/palette.md
      - percentiles-heatmap: asl/ref/percentiles-heatmap.md
      - order: asl/ref/order.md
      - s: asl/ref/s.md
      - sort: asl/ref/sort.md
      - stack: asl/ref/stack.md
      - vspan: asl/ref/vspan.md
    - Stack Manipulation:
      - -rot: asl/ref/-rot.md
      - 2over: asl/ref/2over.md
      - call: asl/ref/call.md
      - clear: asl/ref/clear.md
      - depth: asl/ref/depth.md
      - drop: asl/ref/drop.md
      - dup: asl/ref/dup.md
      - each: asl/ref/each.md
      - fcall: asl/ref/fcall.md
      - freeze: asl/ref/freeze.md
      - get: asl/ref/get.md
      - list: asl/ref/list.md
      - map: asl/ref/map.md
      - ndrop: asl/ref/ndrop.md
      - nip: asl/ref/nip.md
      - nlist: asl/ref/nlist.md
      - over: asl/ref/over.md
      - pick: asl/ref/pick.md
      - roll: asl/ref/roll.md
      - rot: asl/ref/rot.md
      - set: asl/ref/set.md
      - sset: asl/ref/sset.md
      - swap: asl/ref/swap.md
      - tuck: asl/ref/tuck.md
    - Utilities:
      - format: asl/ref/format.md
      - named-rewrite: asl/ref/named-rewrite.md
    - Deprecated:
      - all: asl/ref/all.md
      - stat-avg-mf: asl/ref/stat-avg-mf.md
      - stat-max-mf: asl/ref/stat-max-mf.md
      - stat-min-mf: asl/ref/stat-min-mf.md
      - trend: asl/ref/trend.md
- Spectator:
  - Overview: spectator/index.md
  - Agent:
    - Usage: spectator/agent/usage.md
    - Metrics: spectator/agent/metrics.md
  - Core Concepts:
    - Clock: spectator/core/clock.md
    - Meters:
      - Counters: spectator/core/meters/counter.md
      - Distribution Summaries: spectator/core/meters/dist-summary.md
      - Gauges: spectator/core/meters/gauge.md
      - Timers: spectator/core/meters/timer.md
  - Languages:
    - Overview: spectator/lang/overview.md
    - C++:
      - Usage: spectator/lang/cpp/usage.md
    - Go:
      - Usage: spectator/lang/go/usage.md
      - Migrations: spectator/lang/go/migrations.md
    - Java:
      - Usage: spectator/lang/java/usage.md
      - Registry:
        - Overview: spectator/lang/java/registry/overview.md
        - Metrics3: spectator/lang/java/registry/metrics3.md
      - Meters:
        - Counters: spectator/lang/java/meters/counter.md
        - Distribution Summaries: spectator/lang/java/meters/dist-summary.md
        - Gauges: spectator/lang/java/meters/gauge.md
        - Percentile Timers: spectator/lang/java/meters/percentile-timer.md
        - Timers: spectator/lang/java/meters/timer.md
      - Extensions:
        - JVM Stats:
          - Buffer Pools: spectator/lang/java/ext/jvm-buffer-pools.md
          - Class Loading: spectator/lang/java/ext/jvm-classloading.md
          - Compilation: spectator/lang/java/ext/jvm-compilation.md
          - Garbage Collection: spectator/lang/java/ext/jvm-gc.md
          - GC Causes: spectator/lang/java/ext/jvm-gc-causes.md
          - Memory Pools: spectator/lang/java/ext/jvm-memory-pools.md
          - Safepoints: spectator/lang/java/ext/jvm-safepoint.md
          - Threads: spectator/lang/java/ext/jvm-threads.md
          - Thread Pools: spectator/lang/java/ext/thread-pools.md
        - Log4j2 Appender: spectator/lang/java/ext/log4j2.md
        - Log4j1 Appender: spectator/lang/java/ext/log4j1.md
        - Placeholders: spectator/lang/java/ext/placeholders.md
      - Testing: spectator/lang/java/testing.md
      - Servo Migration: spectator/lang/java/servo-migration.md
    - Node.js:
      - Usage: spectator/lang/nodejs/usage.md
      - Extensions:
        - Node.js Stats:
          - CPU: spectator/lang/nodejs/ext/nodejs-cpu.md
          - Event Loop: spectator/lang/nodejs/ext/nodejs-eventloop.md
          - File Descriptor: spectator/lang/nodejs/ext/nodejs-filedescriptor.md
          - Garbarge Collection: spectator/lang/nodejs/ext/nodejs-gc.md
          - Heap: spectator/lang/nodejs/ext/nodejs-heap.md
          - Heap Space: spectator/lang/nodejs/ext/nodejs-heapspace.md
          - Memory: spectator/lang/nodejs/ext/nodejs-memory.md
      - Meters:
        - Counter: spectator/lang/nodejs/meters/counter.md
        - Distribution Summary: spectator/lang/nodejs/meters/dist-summary.md
        - Gauge: spectator/lang/nodejs/meters/gauge.md
        - Percentile Timer: spectator/lang/nodejs/meters/percentile-timer.md
        - Timer: spectator/lang/nodejs/meters/timer.md
    - Python:
      - Usage: spectator/lang/py/usage.md
      - Meters:
        - Age Gauge: spectator/lang/py/meters/age-gauge.md
        - Counter: spectator/lang/py/meters/counter.md
        - Distribution Summary: spectator/lang/py/meters/dist-summary.md
        - Gauges: spectator/lang/py/meters/gauge.md
        - Max Gauge: spectator/lang/py/meters/max-gauge.md
        - Monotonic Counter: spectator/lang/py/meters/monotonic-counter.md
        - Monotonic Counter Uint: spectator/lang/py/meters/monotonic-counter-uint.md
        - Percentile Distribution Summary: spectator/lang/py/meters/percentile-dist-summary.md
        - Percentile Timer: spectator/lang/py/meters/percentile-timer.md
        - Timer: spectator/lang/py/meters/timer.md
      - Migrations: spectator/lang/py/migrations.md
    - Ruby:
      - Deprecated: spectator/lang/rb/deprecated.md
  - Patterns:
    - Cardinality Limiter: spectator/patterns/cardinality-limiter.md
    - Gauge Poller: spectator/patterns/gauge-poller.md
    - Interval Counter: spectator/patterns/interval-counter.md
    - Long Task Timer: spectator/patterns/long-task-timer.md
    - Percentile Timer: spectator/patterns/percentile-timer.md
    - Polled Meter: spectator/patterns/polled-meter.md
  - Specifications:
    - IPC: spectator/specs/ipc.md

theme:
  name: material
  favicon: 'images/favicon.ico'
  features:
    - navigation.tabs
  logo: 'images/atlas_logo.svg'
  palette:
    primary: 'red'
    accent: 'red'

extra:
  spectator_api:
      java_latest: 0.101.0

extra_css:
  - css/custom.css

markdown_extensions:
  - admonition
  - codehilite
  - pymdownx.superfences
  - pymdownx.tilde
  - attr_list
  - toc:
      permalink: True

plugins:
  - markdownextradata: {}
  - search
  - atlas_formatting