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

Fixes #4368 #4421

Closed
Closed

Conversation

michael2893
Copy link

@michael2893 michael2893 commented May 3, 2024

Summary

This change addresses the request for documentation on the Single-Writer principle. #4368

Description

  • add section on multiple collector deployments in deployment/gateway
  • define single writer principle
  • provide examples and context

Open questions

  • Can I provide examples from open issues to help better capture this problem?

Copy link

linux-foundation-easycla bot commented May 3, 2024

CLA Missing ID CLA Not Signed

Copy link
Member

@theletterf theletterf left a comment

Choose a reason for hiding this comment

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

Thanks! Please have a look at the questions. Also, you'll need to sign the CLA.

@open-telemetry/collector-maintainers Please have a look, thanks!

---
title: The Single Writer Principle
description: How to handle the single writer principle in Collector deployments
weight: 1
Copy link
Member

Choose a reason for hiding this comment

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

Alter the weight of the page so that it shows below "Gateway".

Suggested change
weight: 1
weight: 4

@@ -0,0 +1,57 @@
---
title: The Single Writer Principle
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
title: The Single Writer Principle
title: The Single Writer Principle

How can we better contextualize what this doc is about when it comes to Collector deployments? Think of a nav title that would fit the progression in the current section. Why should someone know about this principle?

Copy link
Member

Choose a reason for hiding this comment

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

Also, could this be a section in an existing doc rather than its own doc?

description: How to handle the single writer principle in Collector deployments
weight: 1
---

Copy link
Member

Choose a reason for hiding this comment

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

As the doc is likely not self-contained, consider adding links from other topics.

@svrnm svrnm added the CLA: no label May 6, 2024
@michael2893 michael2893 marked this pull request as ready for review May 6, 2024 23:28
@michael2893 michael2893 requested review from a team as code owners May 6, 2024 23:28
@michael2893 michael2893 requested review from Aneurysm9 and removed request for a team May 6, 2024 23:28
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.

None yet

3 participants