opentelemetry.io icon indicating copy to clipboard operation
opentelemetry.io copied to clipboard
verified publisher icon open-telemetry

Collector docs on single-writer principle

Open michael2893 opened this issue 1 year ago • 11 comments

Summary

This change addresses the request for documentation on the Single-Writer principle. https://github.com/open-telemetry/opentelemetry.io/issues/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?

michael2893 avatar May 07 '24 01:05 michael2893

@open-telemetry/collector-approvers ptal

svrnm avatar May 07 '24 08:05 svrnm

/fix:all

chalin avatar Jun 08 '24 09:06 chalin

You triggered fix:all action run at https://github.com/open-telemetry/opentelemetry.io/actions/runs/9427840190

opentelemetrybot avatar Jun 08 '24 09:06 opentelemetrybot

fix:all run failed, please check https://github.com/open-telemetry/opentelemetry.io/actions/runs/9427840190 for details

opentelemetrybot avatar Jun 08 '24 09:06 opentelemetrybot

/fix:markdown

chalin avatar Jun 08 '24 09:06 chalin

You triggered fix:markdown action run at https://github.com/open-telemetry/opentelemetry.io/actions/runs/9427849345

opentelemetrybot avatar Jun 08 '24 09:06 opentelemetrybot

fix:markdown run failed, please check https://github.com/open-telemetry/opentelemetry.io/actions/runs/9427849345 for details

opentelemetrybot avatar Jun 08 '24 09:06 opentelemetrybot

@michael2893 do not worry too much about the markdown, link issues, etc. lets make sure that the content is right and then we can fix the PR accordingly.

Have you addressed the feedback by @jpkrohling, if so we need another round of reviews :-)

svrnm avatar Jun 10 '24 06:06 svrnm

@svrnm Hi - yes I did address the content issues from the comments above

michael2893 avatar Jun 10 '24 12:06 michael2893

Ah, ok, right. I think with this change, I could enhance context in the existing docs with additional notes without restating as much as I have, depending on what the desired outcome for 4368 is!

michael2893 avatar Jun 14 '24 13:06 michael2893

I have not had time to look into this PR yet, I will try to do it next week. What I had in mind in general terms is a page I can refer users to when they face trouble because they have an incorrect setup where the same metric stream is being produced by multiple writers. For an example, see https://github.com/open-telemetry/opentelemetry-collector-contrib/issues/32043#issuecomment-2062329429. I'll try to give a more thorough review soon

mx-psi avatar Jun 14 '24 14:06 mx-psi

any updates?

svrnm avatar Jul 11 '24 13:07 svrnm

Sorry, this slipped through the cracks, let me add it to my queue :+1:

mx-psi avatar Jul 11 '24 13:07 mx-psi

@michael2893 do you know what to do next?

svrnm avatar Aug 01 '24 09:08 svrnm

@svrnm yep! working on condensing this and moving it into 'deployment'

michael2893 avatar Aug 01 '24 14:08 michael2893

@mx-psi - just to clarify, can this can go under gateway in collector/deployment? I thought that could be an appropriate place for the note, but just wanted to check before pushing anymore changes

michael2893 avatar Aug 07 '24 18:08 michael2893

@mx-psi - just to clarify, can this can go under gateway in collector/deployment? I thought that could be an appropriate place for the note, but just wanted to check before pushing anymore changes

Yeah, I think it can fit there :)

mx-psi avatar Aug 13 '24 15:08 mx-psi

CLA Missing ID CLA Not Signed

  • :white_check_mark: login: jurabek / name: Jurabek Azizkhujaev (bd4aa0832970c67efc771497da624edeaf49330c)
  • :white_check_mark: login: opentelemetrybot / name: OpenTelemetry Bot (83472b45cd97b7471eb71f641eca6ddfbff6651f, 259489e39c4b992efb7f7f5b9047ffab51935ba2, ec32cf17736d7d595fdc49fa62fd32f47fb3bc56, 64227d35f82a78d46ed67f1d615b37b767743168, 787837e36c44c299244e9a59f7caf29e39734a69, 8f38791cf85c30e155c8b622e8a1413bee9d93f0, 4962ccff189fd5f5a2426a5e5ec6455c0ef7551e, 49bb7723e58d2c6c314bfaaa959bd5397bc9c6ce)
  • :white_check_mark: login: krol3 / name: Carol Valencia (187e763bb3d7ebee59ada35b035fb3a742491060, ca1fd1c6ae42d6894ebab3a6f500a47107798651)
  • :white_check_mark: login: michael2893 (b46d3b605626e8999f05763f1c5fd0c439f438bc, c5cae817a3170963b7e084453accf38cc54ac868, 198e9370fb632d617c3eca33e00906da69a41c61, af60cba3f086da355dc4e2e5a2d1d0fdc1100af6, 57400a8613ceb16675ef8ce2f8393f62f5f40ec7, b85b4c91547e80a4b61d040482d9eacf4ecba0dc, 2d205abf7903c67eb07057d4712162f49195b66e, b6db3c49c27966277afb5873b9daf7f587701133, 751765464cb83945047878ad558c55913fa083a5, c7c192e7c2feae57a103d39cf411ee9740ea9b66, dfb03f2081fa9be4eabca1425c907c3960208b2f, 3736b0acbe8ffc937366e17885b3fb2102acc516, ca2b41a6db7c9f0413dba547bf37f9c3e0a40d32, ec0aa3db9512ef6bc4a6ad9ab4ea0b5bca3aafe7, a4dcb49cc463e508f9e1c9bbf614ed2736a58af7, f1a7d4beea212f9578c1c45217e304c46f767b31, a6c9b6537cd456af023c1d7763b196a3743b7020, 06ad6898a65afa34f1d818b6aa82fe0b70a967e3, 2676b5c11fcd83c916621c2f04aec6c3a6710ba2, 71f6c659a3f61fcf810ec236e9d4fbaeb3aa011a, 81ebef9708bde8b0ef34f9ff71389085f76db946)
  • :white_check_mark: login: dependabot[bot] (1d19cb103783edd84f1e0d321354e15af85e030f, 5f8fff1ce64159431a2c41d7f150947dd2dbe62e, 54751a002fb3ea5816def11dd158ef258f788fbe)
  • :white_check_mark: login: chalin / name: Patrice Chalin (666dd5a402ab4e220a01481ccd2545590ca6f49d, 633d862c535351b6905125b4b59beeedacf04fd9, 8a72552c696232fa1f3ac9749b1f81bdf1df85a9, 4685784e69b4128b0f5d50b93bc8f35c8d38888d, 7a113780e31ea4f14056ef12c9856c0872abe359, 85371c7f1db53bb7b5c31970fe55c06746638557, 3cfd724d5f2f3003feba694288448ceff4c3aca7, 7f45f12803cd54753defca4b2467039ee5e791c6)
  • :white_check_mark: login: bogdan-at-adobe (0589ca77e7659b85a1fc2491cfd488f8597b2615)
  • :white_check_mark: login: drewhammond / name: Drew Hammond (c445f363bfe5a0c126ab133c9cc8d680abe50ec4, be090125a00d6c22b8352e0ffa35d3871573f99d)
  • :white_check_mark: login: shalk / name: shalk(xiao kun) (1a83914b74e4929bcb5ce43c0933572c16fef5dd)
  • :white_check_mark: login: MrAlias / name: Tyler Yahn (940db0586fb92b1495bb4742af91cff5725000c8, 66a17a5884df8a4ff8dbb396d5f7ba0df68bb64d)
  • :white_check_mark: login: tedder / name: tedder (14eec435defbac893bfcc5a88c3a2690f1cdeb9b)
  • :white_check_mark: login: igorestevanjasinski / name: Igor Estevan Jasinski (11bebfaa973ea2b0d2d85a731daccfc42e385f31)
  • :white_check_mark: login: CFly17 (993b0eb5533e4ddefa9947063cdc946c4ee415fe)
  • :white_check_mark: login: reese-lee / name: Reese Lee (9b36c179995228b30ec48ac463f787ef09e62fca)
  • :white_check_mark: login: vitorvasc / name: Vitor Vasconcellos (c0e34faf4cb040ee574e7cd861632b1aca1d0156)
  • :white_check_mark: login: danielgblanco / name: Daniel Gomez Blanco (5e9db1c130d2deef401bd23d0d1dc9b7f6fb2851)
  • :white_check_mark: login: pdgonzalez872 / name: Paulo Daniel Gonzalez (5d629bbd1d8e477e4ff90fc888df2b2a111fa87f)
  • :white_check_mark: login: EzzioMoreira / name: Ezzio Moreira (503caee25969b472e5d39bb1091decbbf1fc5cb4)
  • :white_check_mark: login: cijothomas / name: Cijo Thomas (060998c9ad354c42ce245c70d5da41cd55dc3911)
  • :white_check_mark: login: Jgilhuly / name: JohnGilhuly (45b87dca1ca8c6521dbf3ee3a982eb38c5080d9b, 9e8961fd7d3a98586943c67e6c0f52ec2c9509df)
  • :white_check_mark: login: danelson / name: Dan Nelson (5528e7cb15b79c791795317c4469b380b1ae8fd1)
  • :white_check_mark: login: damemi / name: Mike Dame (6dc98d3e63d87249745c56e5318f048566c8f7dd)
  • :white_check_mark: login: LiraLemur / name: Sara (7765fb036c014c10afc4fd9ea171d9dd33db3296)
  • :white_check_mark: login: jamesmoessis / name: James Moessis (4c03ab729692e89335f97c659f74d25b243d6c0d)
  • :white_check_mark: login: sahilk / name: Sahil Khan (ba50f9cc3b4dbe7e129c092df8f91c1b95f6f233)
  • :white_check_mark: login: TylerHelmuth / name: Tyler Helmuth (3f43ad7b173288a05b46df9e2f39f1b4a86fda57)
  • :white_check_mark: login: janssenlima / name: Janssen dos Reis Lima (f983cdfc8973c5f5a50f6947b02e4f15a12c1d53)
  • :x: The email address for the commit (8abfd04c823241ff8ee5b08e79431ea088101ffc, 26501cb78934689a24f7c8f6797be16f045a4b60) is not linked to the GitHub account, preventing the EasyCLA check. Consult this Help Article and GitHub Help to resolve. (To view the commit's email address, add .patch at the end of this PR page's URL.) For further assistance with EasyCLA, please submit a support request ticket.

linux-foundation-easycla[bot] avatar Aug 23 '24 23:08 linux-foundation-easycla[bot]

@michael2893 unfortunately one of your commits came from a different email not covered by the CLA. I'd recommend squashing that commit.

cartermp avatar Aug 25 '24 18:08 cartermp

there was an issue with squashing the commits from the invalid email here, so I just moved the change to here: https://github.com/open-telemetry/opentelemetry.io/pull/5166

michael2893 avatar Sep 30 '24 13:09 michael2893