From 0951dc2533cdc5d57d9532b7ca6135189bc20b44 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Robert=20Paj=C4=85k?= Date: Wed, 8 Nov 2023 10:07:43 +0100 Subject: [PATCH] Add OTel logs design --- .github/dependabot.yml | 9 +++++++++ README.md | 13 +++++-------- design/log/README.md | 33 +++++++++++++++++++++++++++++++++ design/log/go.mod | 3 +++ versions.yaml | 1 + 5 files changed, 51 insertions(+), 8 deletions(-) create mode 100644 design/log/README.md create mode 100644 design/log/go.mod diff --git a/.github/dependabot.yml b/.github/dependabot.yml index f4c687ce090..a2853c62398 100644 --- a/.github/dependabot.yml +++ b/.github/dependabot.yml @@ -64,6 +64,15 @@ updates: schedule: interval: weekly day: sunday + - package-ecosystem: gomod + directory: /design/log + labels: + - dependencies + - go + - Skip Changelog + schedule: + interval: weekly + day: sunday - package-ecosystem: gomod directory: /example/dice labels: diff --git a/README.md b/README.md index 41bc6a26a67..ad58f6568be 100644 --- a/README.md +++ b/README.md @@ -11,14 +11,11 @@ It provides a set of APIs to directly measure performance and behavior of your s ## Project Status -| Signal | Status | -|---------|--------------------| -| Traces | Stable | -| Metrics | Stable | -| Logs | In Development [1] | - -- [1]: Currently the logs signal development is in a design phase. - No Logs Pull Requests are currently being accepted. +| Signal | Status | +|---------|----------------------------------------------------------------------------------| +| Traces | Stable | +| Metrics | Stable | +| Logs | Design ([#4696](https://github.com/open-telemetry/opentelemetry-go/issues/4696)) | Progress and status specific to this repository is tracked in our [project boards](https://github.com/open-telemetry/opentelemetry-go/projects) diff --git a/design/log/README.md b/design/log/README.md new file mode 100644 index 00000000000..14f0070beba --- /dev/null +++ b/design/log/README.md @@ -0,0 +1,33 @@ +# Proposal: OpenTelemetry Logs + +Discussion at [#4696](https://github.com/open-telemetry/opentelemetry-go/issues/4696). + +## Abstract + +[A short summary of the proposal.] + +## Background + +[An introduction of the necessary background and the problem being solved by the proposed change.] + +## Proposal + +[A precise statement of the proposed change.] + +## Rationale + +[A discussion of alternate approaches and the trade offs, advantages, and disadvantages of the specified approach.] + +## Compatibility + +[A discussion of the change with regard to the +[compatibility guidelines](https://go.dev/doc/go1compat).] + +## Implementation + +[A description of the steps in the implementation, who will do them, and when.] + +## Open issues (if applicable) + +[A discussion of issues relating to this proposal for which the author does not +know the solution. This section may be omitted if there are none.] diff --git a/design/log/go.mod b/design/log/go.mod new file mode 100644 index 00000000000..a3d2716b1ca --- /dev/null +++ b/design/log/go.mod @@ -0,0 +1,3 @@ +module go.opentelemetry.io/otel/design/log + +go 1.20 diff --git a/versions.yaml b/versions.yaml index 7d212769240..bc8f4a2171a 100644 --- a/versions.yaml +++ b/versions.yaml @@ -52,4 +52,5 @@ module-sets: modules: - go.opentelemetry.io/otel/schema excluded-modules: + - go.opentelemetry.io/otel/design/log - go.opentelemetry.io/otel/internal/tools