Skip to content

metadata #95

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

Open
wants to merge 4 commits into
base: main
Choose a base branch
from
Open

metadata #95

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
fe2376c
metadata
Olli73773 Feb 20, 2023
258f187
metadata
Olli73773 Feb 20, 2023
a9b8eb7
Merge branch 'olli73773-metadata' of https://github.com/Olli73773/tag…
Olli73773 Feb 5, 2024
b8e5d4d
rebase
Olli73773 Feb 5, 2024
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
16 changes: 16 additions & 0 deletions whitepaper.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,8 @@ See [the contributing section](#contributing) on proposing changes to this paper
* [Standardized query layer](#standardized-query-layer)
* [More Observability Databases in OSS](#more-observability-databases-in-oss)
* [Monitoring for Streaming APIs](#monitoring-for-streaming-apis)
* [In practice](#in-practice)
* [Common source of useful metadata](#common-source-of-useful-metadata)
* [References](#references)
* [Contributors](#contributors)
* [Contributing](#contributing)
Expand Down Expand Up @@ -492,6 +494,19 @@ There are a few very well-known monitoring methodologies today. For example, the

Unfortunately, both methodologies are hard to implement for Streaming APIs. With the popularization of streaming Remote Procedure Calls (RPC), e.g. gRPC, we must develop a new or updated methodology and tools to monitor those.

## In practice

### Common source of useful metadata

The main source of metadata are dimensions in metrics, span tags in traces and so on in your observability stack. Additional to the metadata in your observability signals, other metadata become important when you work in bigger distributed applications.

Think about a bigger web shop, there might be a team providing services for customer data, an other team providing services for stock allocation and so on. You might even depend on some external services for billing.

In order to quickly respond to any problem you need the contact data for each service.
Or you found a problem in a container image and you want to inform the other teams that use the same image.

In practice a common source of metadata is important to store additional metadata like support contacts, links to knowledged bases and more. Tools like [backstage](https://backstage.io/) are helpful to collect the metadata from different source and make easy them accessible.

## References

1. HARTMANN, Richard. Talk given at Fosdem (Brussels), Feb 2019. Available at: https://archive.fosdem.org/2019/schedule/event/on_observability_2019/. Accessed on: June 24, 2021.
Expand Down Expand Up @@ -533,6 +548,7 @@ From the first words written until its completion, this whitepaper was a communi
* [Matt Young](https://github.com/halcyondude)
* [Michael Hausenblas](https://github.com/mhausenblas)
* [Nicolas Takashi](https://github.com/nicolastakashi)
* [Oliver Edelmann](https://github.com/Olli73773)
* [Rafael Natali](https://github.com/rafaelmnatali)
* [Richard Anton](https://github.com/ranton256)
* [RichiH "RichiH" Hartmann](https://github.com/RichiH)
Expand Down