Add single writer principle note to deployment documentation #5166
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
opentelemetrybot
requested review from
atoulme
and removed request for
a team
tiffany76
reviewed
Sep 9, 2024
| @@ -218,3 +218,48 @@ Cons: | |||
| https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/main/processor/tailsamplingprocessor | |||
| [spanmetrics-connector]: | |||
| https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/main/connector/spanmetricsconnector | |||
|
|
|||
| ## Multiple Collectors / Single Writer Principle | |||
There was a problem hiding this comment.
I spent an absurd amount of time trying to determine if the name of the principle should be capitalized and hyphenated. If we're going for consistency, the spec page uses "Single-Writer principle". I agree with the hyphen when used before "principle", but I think it should all be lowercase. Please (anyone) contradict me if you think otherwise.
Suggested change
| ## Multiple Collectors / Single Writer Principle | |
| ## Multiple collectors and the single-writer principle |
Comment on lines
229
to
230
|
|
||
|
|
There was a problem hiding this comment.
Please remove the extra spaces between paragraphs, here and elsewhere. Thanks!
|
|
||
|
|
||
|
|
||
| ### Potential Problems |
There was a problem hiding this comment.
Suggested change
| ### Potential Problems | |
| ### Potential problems |
| ### Potential Problems | ||
|
|
||
| Concurrent access from multiple applications that modify or report on | ||
| the same data can lead to data loss or, at least, degraded data |
There was a problem hiding this comment.
Does concurrent access always lead to degraded data quality? If not, I would remove the "at least".
Suggested change
| the same data can lead to data loss or, at least, degraded data | |
| the same data can lead to data loss or degraded data |
Comment on lines
236
to
238
| quality. An example would be something like inconsistent data from multiple sources | ||
| on the same resource, where the different sources can overwrite each other because | ||
| the resource is not uniquely identified. |
There was a problem hiding this comment.
Suggested change
| quality. An example would be something like inconsistent data from multiple sources | |
| on the same resource, where the different sources can overwrite each other because | |
| the resource is not uniquely identified. | |
| quality. For example, you might see inconsistent data from multiple sources | |
| on the same resource, where the different sources can overwrite each other because | |
| the resource is not uniquely identified. |
Comment on lines
251
to
252
| This could indicate that identical targets exist in two jobs, and the order of | ||
| the timestamps is incorrect. |
There was a problem hiding this comment.
Suggested change
| This could indicate that identical targets exist in two jobs, and the order of | |
| the timestamps is incorrect. | |
| This error could indicate that identical targets exist in two jobs, and the order of | |
| the timestamps is incorrect. For example: |
| This could indicate that identical targets exist in two jobs, and the order of | ||
| the timestamps is incorrect. | ||
|
|
||
| Ex: |
| - Metric `M1` received at time 13:56:04 with value `110` | ||
|
|
||
|
|
||
| ### Suggestions |
There was a problem hiding this comment.
Is there a more descriptive heading we can use here? "Best practices", maybe?
Comment on lines
262
to
263
| - Use the [Kubernetes Attributes Processor](https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/main/processor/k8sattributesprocessor) | ||
| to add labels to kubernetes resources |
There was a problem hiding this comment.
Suggested change
| - Use the [Kubernetes Attributes Processor](https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/main/processor/k8sattributesprocessor) | |
| to add labels to kubernetes resources | |
| - Use the [Kubernetes attributes processor](https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/main/processor/k8sattributesprocessor) | |
| to add labels to Kubernetes resources. |
Comment on lines
264
to
265
| - Use the [Resource Detector Processor](https://github.com/open-telemetry/opentelemetry-collector-contrib/blob/main/processor/resourcedetectionprocessor/README.md) | ||
| to detect resource information from the host and collect metadata related to them. |
There was a problem hiding this comment.
Suggested change
| - Use the [Resource Detector Processor](https://github.com/open-telemetry/opentelemetry-collector-contrib/blob/main/processor/resourcedetectionprocessor/README.md) | |
| to detect resource information from the host and collect metadata related to them. | |
| - Use the [resource detector processor](https://github.com/open-telemetry/opentelemetry-collector-contrib/blob/main/processor/resourcedetectionprocessor/README.md) | |
| to detect resource information from the host and collect resource metadata. |
|
Hi @michael2893. Thanks for sticking with this. A couple of the Collector maintainers reviewed the earlier PR (#4433), so I'm going to ask them to take a look here and make sure their comments have been addressed. @jpkrohling, @mx-psi, PTAL. Thanks! |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
This change addresses the request for documentation on the Single-Writer principle. #4368
Description
deployment/gateway