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.

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

Create observability configuration document #1882

Merged

Conversation

vankichi
Copy link
Contributor

@vankichi vankichi commented Dec 5, 2022

Description:

I have created the observability configuration (v1.7~).
It requires OpenTelemetry and OpenTelemtry Protocol for observing.

Related Issue:

Versions:

  • Go Version: 1.19.2
  • Docker Version: 20.10.8
  • Kubernetes Version: 1.22.0
  • NGT Version: 1.14.8

Checklist:

Special notes for your reviewer:

Signed-off-by: vankichi <kyukawa315@gmail.com>
@vdaas-ci
Copy link
Collaborator

vdaas-ci commented Dec 5, 2022

[CHATOPS:HELP] ChatOps commands.

  • 🙆‍♀️ /approve - approve
  • 💌 /changelog - replace the PR body by changelog details
  • 🍱 /format - format codes and add licenses
  • /gen-test - generate test codes
  • 🏷️ /label - add labels
  • /rebase - rebase main
  • 🔚 2️⃣ 🔚 /label actions/e2e-deploy - run E2E deploy & integration test

```yaml
defaults:
observability:
# enable version info metrics
Copy link
Contributor

Choose a reason for hiding this comment

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

[LanguageTool] reported by reviewdog 🐶
Possible typo: you repeated a word (ENGLISH_WORD_REPEAT_RULE)
Suggestions: metrics
Rule: https://community.languagetool.org/rule/show/ENGLISH_WORD_REPEAT_RULE?lang=en-US
Category: MISC

metrics:
enable_version_info: true
# If the enable_version_info setting is true, this information will be added to the keys of the version info metrics.
version_info_labels:
Copy link
Contributor

Choose a reason for hiding this comment

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

[LanguageTool] reported by reviewdog 🐶
This sentence does not start with an uppercase letter. (UPPERCASE_SENTENCE_START)
Suggestions: Version
URL: https://languagetool.org/insights/post/spelling-capital-letters/
Rule: https://community.languagetool.org/rule/show/UPPERCASE_SENTENCE_START?lang=en-US
Category: CASING

observability:
otlp:
attribute:
# deployed namespace
Copy link
Contributor

Choose a reason for hiding this comment

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

[LanguageTool] reported by reviewdog 🐶
Possible typo: you repeated a word (ENGLISH_WORD_REPEAT_RULE)
Suggestions: namespace
Rule: https://community.languagetool.org/rule/show/ENGLISH_WORD_REPEAT_RULE?lang=en-US
Category: MISC

observability:
otlp:
# Maximum duration for constructing a batch from the queue. The Processor forcefully sends available spans when timeout is reached.
trace_batch_timeout: "1s"
Copy link
Contributor

Choose a reason for hiding this comment

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

[LanguageTool] reported by reviewdog 🐶
This sentence does not start with an uppercase letter. (UPPERCASE_SENTENCE_START)
Suggestions: Trace
URL: https://languagetool.org/insights/post/spelling-capital-letters/
Rule: https://community.languagetool.org/rule/show/UPPERCASE_SENTENCE_START?lang=en-US
Category: CASING

# Maximum duration for constructing a batch from the queue. The Processor forcefully sends available spans when timeout is reached.
trace_batch_timeout: "1s"
# Maximum duration for exporting trace spans
trace_export_timeout: "1m"
Copy link
Contributor

Choose a reason for hiding this comment

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

[LanguageTool] reported by reviewdog 🐶
Insert a space between the numerical value and the unit symbol. (UNIT_SPACE[1])
Suggestions: 1 m
Rule: https://community.languagetool.org/rule/show/UNIT_SPACE?lang=en-US&subId=1
Category: PUNCTUATION

trace_max_export_batch_size: 1024
# Maximum queue size to buffer trace spans for delayed processing.
trace_max_queue_size: 256
# Export interval for metrics
Copy link
Contributor

Choose a reason for hiding this comment

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

[LanguageTool] reported by reviewdog 🐶
Possible typo: you repeated a word (ENGLISH_WORD_REPEAT_RULE)
Suggestions: metrics
Rule: https://community.languagetool.org/rule/show/ENGLISH_WORD_REPEAT_RULE?lang=en-US
Category: MISC

trace_max_queue_size: 256
# Export interval for metrics
metrics_export_interval: "1s"
# Maximum duration for exporting metrics
Copy link
Contributor

Choose a reason for hiding this comment

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

[LanguageTool] reported by reviewdog 🐶
Possible typo: you repeated a word (ENGLISH_WORD_REPEAT_RULE)
Suggestions: metrics
Rule: https://community.languagetool.org/rule/show/ENGLISH_WORD_REPEAT_RULE?lang=en-US
Category: MISC

# Export interval for metrics
metrics_export_interval: "1s"
# Maximum duration for exporting metrics
metrics_export_timeout: "1m"
Copy link
Contributor

Choose a reason for hiding this comment

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

[LanguageTool] reported by reviewdog 🐶
Insert a space between the numerical value and the unit symbol. (UNIT_SPACE[1])
Suggestions: 1 m
Rule: https://community.languagetool.org/rule/show/UNIT_SPACE?lang=en-US&subId=1
Category: PUNCTUATION

server:
grpc:
# gRPC Server interceptor.
interceptors:
Copy link
Contributor

Choose a reason for hiding this comment

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

[LanguageTool] reported by reviewdog 🐶
This sentence does not start with an uppercase letter. (UPPERCASE_SENTENCE_START)
Suggestions: Interceptors
URL: https://languagetool.org/insights/post/spelling-capital-letters/
Rule: https://community.languagetool.org/rule/show/UPPERCASE_SENTENCE_START?lang=en-US
Category: CASING

- MetricInterceptor
grpc:
# gRPC Client interceptor.
client:
Copy link
Contributor

Choose a reason for hiding this comment

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

[LanguageTool] reported by reviewdog 🐶
This sentence does not start with an uppercase letter. (UPPERCASE_SENTENCE_START)
Suggestions: Client
URL: https://languagetool.org/insights/post/spelling-capital-letters/
Rule: https://community.languagetool.org/rule/show/UPPERCASE_SENTENCE_START?lang=en-US
Category: CASING

Co-authored-by: Hiroto Funakoshi <hiroto.funakoshi.hiroto@gmail.com>
@cloudflare-workers-and-pages
Copy link

cloudflare-workers-and-pages bot commented Dec 5, 2022

Deploying with  Cloudflare Pages  Cloudflare Pages

Latest commit: a2cbc14
Status: ✅  Deploy successful!
Preview URL: https://3c1ce0ab.vald.pages.dev
Branch Preview URL: https://documentation-docs-create-ob.vald.pages.dev

View logs

@vankichi vankichi requested a review from hlts2 December 5, 2022 02:09
```yaml
defaults:
observability:
# enable version info metrics
Copy link
Contributor

Choose a reason for hiding this comment

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

[LanguageTool] reported by reviewdog 🐶
Possible typo: you repeated a word (ENGLISH_WORD_REPEAT_RULE)
Suggestions: metrics
Rule: https://community.languagetool.org/rule/show/ENGLISH_WORD_REPEAT_RULE?lang=en-US
Category: MISC

metrics:
enable_version_info: true
# If the enable_version_info setting is true, this information will be added to the keys of the version info metrics.
version_info_labels:
Copy link
Contributor

Choose a reason for hiding this comment

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

[LanguageTool] reported by reviewdog 🐶
This sentence does not start with an uppercase letter. (UPPERCASE_SENTENCE_START)
Suggestions: Version
URL: https://languagetool.org/insights/post/spelling-capital-letters/
Rule: https://community.languagetool.org/rule/show/UPPERCASE_SENTENCE_START?lang=en-US
Category: CASING

observability:
otlp:
attribute:
# deployed namespace
Copy link
Contributor

Choose a reason for hiding this comment

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

[LanguageTool] reported by reviewdog 🐶
Possible typo: you repeated a word (ENGLISH_WORD_REPEAT_RULE)
Suggestions: namespace
Rule: https://community.languagetool.org/rule/show/ENGLISH_WORD_REPEAT_RULE?lang=en-US
Category: MISC

observability:
otlp:
# Maximum duration for constructing a batch from the queue. The Processor forcefully sends available spans when timeout is reached.
trace_batch_timeout: "1s"
Copy link
Contributor

Choose a reason for hiding this comment

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

[LanguageTool] reported by reviewdog 🐶
This sentence does not start with an uppercase letter. (UPPERCASE_SENTENCE_START)
Suggestions: Trace
URL: https://languagetool.org/insights/post/spelling-capital-letters/
Rule: https://community.languagetool.org/rule/show/UPPERCASE_SENTENCE_START?lang=en-US
Category: CASING

# Maximum duration for constructing a batch from the queue. The Processor forcefully sends available spans when timeout is reached.
trace_batch_timeout: "1s"
# Maximum duration for exporting trace spans
trace_export_timeout: "1m"
Copy link
Contributor

Choose a reason for hiding this comment

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

[LanguageTool] reported by reviewdog 🐶
Insert a space between the numerical value and the unit symbol. (UNIT_SPACE[1])
Suggestions: 1 m
Rule: https://community.languagetool.org/rule/show/UNIT_SPACE?lang=en-US&subId=1
Category: PUNCTUATION

# Maximum duration for exporting trace spans
trace_export_timeout: "1m"
# Maximum batch size of trace spans.
trace_max_export_batch_size: 1024
Copy link
Contributor

Choose a reason for hiding this comment

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

[LanguageTool] reported by reviewdog 🐶
This sentence does not start with an uppercase letter. (UPPERCASE_SENTENCE_START)
Suggestions: Trace
URL: https://languagetool.org/insights/post/spelling-capital-letters/
Rule: https://community.languagetool.org/rule/show/UPPERCASE_SENTENCE_START?lang=en-US
Category: CASING

trace_max_export_batch_size: 1024
# Maximum queue size to buffer trace spans for delayed processing.
trace_max_queue_size: 256
# Export interval for metrics
Copy link
Contributor

Choose a reason for hiding this comment

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

[LanguageTool] reported by reviewdog 🐶
Possible typo: you repeated a word (ENGLISH_WORD_REPEAT_RULE)
Suggestions: metrics
Rule: https://community.languagetool.org/rule/show/ENGLISH_WORD_REPEAT_RULE?lang=en-US
Category: MISC

# Export interval for metrics
metrics_export_interval: "1s"
# Maximum duration for exporting metrics
metrics_export_timeout: "1m"
Copy link
Contributor

Choose a reason for hiding this comment

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

[LanguageTool] reported by reviewdog 🐶
Insert a space between the numerical value and the unit symbol. (UNIT_SPACE[1])
Suggestions: 1 m
Rule: https://community.languagetool.org/rule/show/UNIT_SPACE?lang=en-US&subId=1
Category: PUNCTUATION

server:
grpc:
# gRPC Server interceptor.
interceptors:
Copy link
Contributor

Choose a reason for hiding this comment

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

[LanguageTool] reported by reviewdog 🐶
This sentence does not start with an uppercase letter. (UPPERCASE_SENTENCE_START)
Suggestions: Interceptors
URL: https://languagetool.org/insights/post/spelling-capital-letters/
Rule: https://community.languagetool.org/rule/show/UPPERCASE_SENTENCE_START?lang=en-US
Category: CASING

- MetricInterceptor
grpc:
# gRPC Client interceptor.
client:
Copy link
Contributor

Choose a reason for hiding this comment

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

[LanguageTool] reported by reviewdog 🐶
This sentence does not start with an uppercase letter. (UPPERCASE_SENTENCE_START)
Suggestions: Client
URL: https://languagetool.org/insights/post/spelling-capital-letters/
Rule: https://community.languagetool.org/rule/show/UPPERCASE_SENTENCE_START?lang=en-US
Category: CASING

```yaml
defaults:
observability:
# enable version info metrics
Copy link
Contributor

Choose a reason for hiding this comment

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

[LanguageTool] reported by reviewdog 🐶
Possible typo: you repeated a word (ENGLISH_WORD_REPEAT_RULE)
Suggestions: metrics
Rule: https://community.languagetool.org/rule/show/ENGLISH_WORD_REPEAT_RULE?lang=en-US
Category: MISC

metrics:
enable_version_info: true
# If the enable_version_info setting is true, this information will be added to the keys of the version info metrics.
version_info_labels:
Copy link
Contributor

Choose a reason for hiding this comment

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

[LanguageTool] reported by reviewdog 🐶
This sentence does not start with an uppercase letter. (UPPERCASE_SENTENCE_START)
Suggestions: Version
URL: https://languagetool.org/insights/post/spelling-capital-letters/
Rule: https://community.languagetool.org/rule/show/UPPERCASE_SENTENCE_START?lang=en-US
Category: CASING

observability:
otlp:
attribute:
# deployed namespace
Copy link
Contributor

Choose a reason for hiding this comment

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

[LanguageTool] reported by reviewdog 🐶
Possible typo: you repeated a word (ENGLISH_WORD_REPEAT_RULE)
Suggestions: namespace
Rule: https://community.languagetool.org/rule/show/ENGLISH_WORD_REPEAT_RULE?lang=en-US
Category: MISC

observability:
otlp:
# Maximum duration for constructing a batch from the queue. The Processor forcefully sends available spans when timeout is reached.
trace_batch_timeout: "1s"
Copy link
Contributor

Choose a reason for hiding this comment

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

[LanguageTool] reported by reviewdog 🐶
This sentence does not start with an uppercase letter. (UPPERCASE_SENTENCE_START)
Suggestions: Trace
URL: https://languagetool.org/insights/post/spelling-capital-letters/
Rule: https://community.languagetool.org/rule/show/UPPERCASE_SENTENCE_START?lang=en-US
Category: CASING

# Maximum duration for constructing a batch from the queue. The Processor forcefully sends available spans when timeout is reached.
trace_batch_timeout: "1s"
# Maximum duration for exporting trace spans
trace_export_timeout: "1m"
Copy link
Contributor

Choose a reason for hiding this comment

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

[LanguageTool] reported by reviewdog 🐶
Insert a space between the numerical value and the unit symbol. (UNIT_SPACE[1])
Suggestions: 1 m
Rule: https://community.languagetool.org/rule/show/UNIT_SPACE?lang=en-US&subId=1
Category: PUNCTUATION

# Maximum duration for exporting trace spans
trace_export_timeout: "1m"
# Maximum batch size of trace spans.
trace_max_export_batch_size: 1024
Copy link
Contributor

Choose a reason for hiding this comment

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

[LanguageTool] reported by reviewdog 🐶
This sentence does not start with an uppercase letter. (UPPERCASE_SENTENCE_START)
Suggestions: Trace
URL: https://languagetool.org/insights/post/spelling-capital-letters/
Rule: https://community.languagetool.org/rule/show/UPPERCASE_SENTENCE_START?lang=en-US
Category: CASING

trace_max_export_batch_size: 1024
# Maximum queue size to buffer trace spans for delayed processing.
trace_max_queue_size: 256
# Export interval for metrics
Copy link
Contributor

Choose a reason for hiding this comment

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

[LanguageTool] reported by reviewdog 🐶
Possible typo: you repeated a word (ENGLISH_WORD_REPEAT_RULE)
Suggestions: metrics
Rule: https://community.languagetool.org/rule/show/ENGLISH_WORD_REPEAT_RULE?lang=en-US
Category: MISC

# Export interval for metrics
metrics_export_interval: "1s"
# Maximum duration for exporting metrics
metrics_export_timeout: "1m"
Copy link
Contributor

Choose a reason for hiding this comment

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

[LanguageTool] reported by reviewdog 🐶
Insert a space between the numerical value and the unit symbol. (UNIT_SPACE[1])
Suggestions: 1 m
Rule: https://community.languagetool.org/rule/show/UNIT_SPACE?lang=en-US&subId=1
Category: PUNCTUATION

server:
grpc:
# gRPC Server interceptor.
interceptors:
Copy link
Contributor

Choose a reason for hiding this comment

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

[LanguageTool] reported by reviewdog 🐶
This sentence does not start with an uppercase letter. (UPPERCASE_SENTENCE_START)
Suggestions: Interceptors
URL: https://languagetool.org/insights/post/spelling-capital-letters/
Rule: https://community.languagetool.org/rule/show/UPPERCASE_SENTENCE_START?lang=en-US
Category: CASING

- MetricInterceptor
grpc:
# gRPC Client interceptor.
client:
Copy link
Contributor

Choose a reason for hiding this comment

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

[LanguageTool] reported by reviewdog 🐶
This sentence does not start with an uppercase letter. (UPPERCASE_SENTENCE_START)
Suggestions: Client
URL: https://languagetool.org/insights/post/spelling-capital-letters/
Rule: https://community.languagetool.org/rule/show/UPPERCASE_SENTENCE_START?lang=en-US
Category: CASING

hlts2
hlts2 previously approved these changes Dec 7, 2022
Copy link
Collaborator

@hlts2 hlts2 left a comment

Choose a reason for hiding this comment

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

LGTM

@vankichi vankichi changed the title [WIP] Create observability configuration document Create observability configuration document Dec 8, 2022
@vankichi vankichi marked this pull request as ready for review December 8, 2022 05:04
datelier
datelier previously approved these changes Dec 13, 2022
@vankichi vankichi dismissed stale reviews from datelier and hlts2 via b2b5f4d December 19, 2022 09:29
Co-authored-by: Hiroto Funakoshi <hiroto.funakoshi.hiroto@gmail.com>
kpango
kpango previously approved these changes Dec 19, 2022
datelier
datelier previously approved these changes Dec 22, 2022
hlts2
hlts2 previously approved these changes Dec 22, 2022
Signed-off-by: vankichi <kyukawa315@gmail.com>
@vankichi vankichi dismissed stale reviews from hlts2, datelier, and kpango via bdd5d6d January 11, 2023 01:29
Copy link
Collaborator

@hlts2 hlts2 left a comment

Choose a reason for hiding this comment

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

LGTM!

@vankichi vankichi merged commit 61845fc into main Jan 12, 2023
@vankichi vankichi deleted the documentation/docs/create-observability-configuration-document branch January 12, 2023 05:24
@kpango kpango mentioned this pull request Jan 19, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants