Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Clean up glossary and overview (resolves #528). #804

Merged
merged 3 commits into from
Aug 14, 2020
Merged

Clean up glossary and overview (resolves #528). #804

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
bf132a3
Clean up glossary and overview (resolves #528).
Oberon00 Aug 14, 2020
7655a06
Overview -> overview document.
Oberon00 Aug 14, 2020
f654222
Remove TOC entry for Code Injecting adapters.
Oberon00 Aug 14, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 25 additions & 2 deletions specification/glossary.md
View file
Open in desktop
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
View file
Open in desktop
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
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Moved this TODO to a new issue #805.


TODO: fill out as a result of SIG discussion.

## Semantic Conventions

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