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

Update table in Observability primer #3517

Merged
merged 4 commits into from
Nov 9, 2023
Merged

Update table in Observability primer #3517

Changes from 2 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
466d42b
Update table in Observability primer
svrnm Nov 8, 2023
4019b62
Merge branch 'main' into update-observability-primer
svrnm Nov 9, 2023
e08c8c0
update cspell ignore list
svrnm Nov 9, 2023
c4243df
update cspell ignore list
svrnm Nov 9, 2023
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
39 changes: 19 additions & 20 deletions content/en/docs/concepts/observability-primer.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
title: Observability Primer
description: Core observability concepts.
weight: 9
cSpell:ignore: KHTML
cSpell:ignore: KHTML webshop
svrnm marked this conversation as resolved.
Show resolved Hide resolved
---

## What is Observability?
Expand Down Expand Up @@ -40,7 +40,7 @@ the system doesn't always add black pants, then the system would be said to be
**Metrics** are aggregations over a period of time of numeric data about your
infrastructure or application. Examples include: system error rate, CPU
utilization, request rate for a given service. For more on metrics and how they
pertain to OTel, see [Metrics](/docs/concepts/signals/metrics/).
pertain to OpenTelemetry, see [Metrics](/docs/concepts/signals/metrics/).

**SLI**, or Service Level Indicator, represents a measurement of a service's
behavior. A good SLI measures your service from the perspective of your users.
Expand Down Expand Up @@ -92,23 +92,22 @@ to provide information about the operation it tracks.

The following table contains examples of span attributes:

| Key | Value |
| ---------------- | ----------------------------------------------------------------------------------------------------------------------- |
| net.transport | `IP.TCP` |
| net.peer.ip | `10.244.0.1` |
| net.peer.port | `10243` |
| net.host.name | `localhost` |
| http.method | `GET` |
| http.target | `/cart` |
| http.server_name | `frontend` |
| http.route | `/cart` |
| http.scheme | `http` |
| http.host | `localhost` |
| http.flavor | `1.1` |
| http.status_code | `200` |
| http.user_agent | `Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/106.0.0.0 Safari/537.36` |

For more on spans and how they pertain to OTel, see
| Key | Value |
| :-------------------------- | :--------------------------------------------------------------------------------- |
| `http.request.method` | `"GET"` |
| `network.protocol.version` | `"1.1"` |
| `url.path` | `"/webshop/articles/4"` |
| `url.query` | `"?s=1"` |
| `server.address` | `"example.com"` |
| `server.port` | `8080` |
| `url.scheme` | `"https"` |
| `http.route` | `"/webshop/articles/:article_id"` |
| `http.response.status_code` | `200` |
| `client.address` | `"192.0.2.4"` |
| `client.socket.address` | `"192.0.2.5"` (the client goes through a proxy) |
| `user_agent.original` | `"Mozilla/5.0 (Windows NT 10.0; Win64; x64; rv:72.0) Gecko/20100101 Firefox/72.0"` |

For more on spans and how they pertain to OpenTelemetry, see
[Spans](/docs/concepts/signals/traces/#spans).

### Distributed Traces
Expand Down Expand Up @@ -143,5 +142,5 @@ Waterfall diagrams show the parent-child relationship between a root span and
its child spans. When a span encapsulates another span, this also represents a
nested relationship.

For more on traces and how they pertain to OTel, see
For more on traces and how they pertain to OpenTelemetry, see
[Traces](/docs/concepts/signals/traces/).