Skip to content

Commit

Permalink
Clean up glossary and overview (resolves #528). (#804)
Browse files Browse the repository at this point in the history
* Clean up glossary and overview (resolves #528).

* Overview -> overview document.

* Remove TOC entry for Code Injecting adapters.
  • Loading branch information
Oberon00 authored Aug 14, 2020
1 parent 40e92c8 commit b10bce8
Show file tree
Hide file tree
Showing 2 changed files with 63 additions and 6 deletions.
27 changes: 25 additions & 2 deletions specification/glossary.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,30 @@
# Glossary

Below are a list of some OpenTelemetry specific terms that are used across this
specification.
This document defines some terms that are used across this specification.

Some other fundamental terms are documented in the [overview document](overview.md).

<!-- Re-generate TOC with `markdown-toc --no-first-h1 -i` -->

<!-- toc -->

- [Common](#common)
* [In-band and Out-of-band Data](#in-band-and-out-of-band-data)
* [Telemetry SDK](#telemetry-sdk)
* [Exporter Library](#exporter-library)
* [Instrumented Library](#instrumented-library)
* [Instrumentation Library](#instrumentation-library)
* [Tracer Name / Meter Name](#tracer-name--meter-name)
- [Logs](#logs)
* [Log Record](#log-record)
* [Log](#log)
* [Embedded Log](#embedded-log)
* [Standalone Log](#standalone-log)
* [Log Attributes](#log-attributes)
* [Structured Logs](#structured-logs)
* [Flat File Logs](#flat-file-logs)

<!-- tocstop -->

## Common

Expand Down
42 changes: 38 additions & 4 deletions specification/overview.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,43 @@
# Overview

<details>
<summary>
Table of Contents
</summary>
<!-- Re-generate TOC with `markdown-toc --no-first-h1 -i` -->

<!-- toc -->

- [Distributed Tracing](#distributed-tracing)
* [Trace](#trace)
* [Span](#span)
* [SpanContext](#spancontext)
* [Links between spans](#links-between-spans)
- [Metrics](#metrics)
* [Recording raw measurements](#recording-raw-measurements)
+ [Measure](#measure)
+ [Measurement](#measurement)
* [Recording metrics with predefined aggregation](#recording-metrics-with-predefined-aggregation)
* [Metrics data model and SDK](#metrics-data-model-and-sdk)
- [Logs](#logs)
* [Data model](#data-model)
- [CorrelationContext](#correlationcontext)
- [Resources](#resources)
- [Context Propagation](#context-propagation)
- [Propagators](#propagators)
- [Collector](#collector)
- [Instrumentation Libraries](#instrumentation-libraries)
- [Semantic Conventions](#semantic-conventions)

<!-- tocstop -->

</details>

This document provides an overview of the pillars of telemetry that
OpenTelemetry supports and defines important fundamental terms.

Additional term definitions can be found in the [glossary](glossary.md).

## Distributed Tracing

A distributed trace is a set of events, triggered as a result of a single
Expand Down Expand Up @@ -290,10 +328,6 @@ name itself. Examples include:
* opentelemetry-instrumentation-flask (Python)
* @opentelemetry/instrumentation-grpc (Javascript)

## Code injecting adapters

TODO: fill out as a result of SIG discussion.

## Semantic Conventions

OpenTelemetry defines standard names and values of Resource attributes and
Expand Down

0 comments on commit b10bce8

Please sign in to comment.