Doc: how to have a custom build and link to contrib repo

[pjanotti]

We need to document how to have builds with custom sets of receivers/processors/exporters and link to contrib repo.

[jpkrohling]

I'm planning on building an "opentelemetry-collector-builder", which would generate a binary based on a list of extra go modules as input. For that, I would certainly appreciate if someone could write a couple of paragraphs on the supported (or expected) way to have a custom build.

My understanding is that I would need to create an entrypoint (main()) that would get defaultcomponents.Components(), generates an component.ApplicationStartInfo, and creates a service.Parameters based on both. From there, all it needs is a service.New().Start(). Is that pretty much it ? If so, please assign this to me, and I'll create this doc as I go along.

[jpkrohling]

The builder that I mentioned above could be used to address open-telemetry/opentelemetry-collector-contrib#873 and open-telemetry/opentelemetry-collector-contrib#35

[jpkrohling]

I got a builder working. It's currently located in my own namespace, but I could move it to OpenTelemetry contrib if you think it's suitable: https://github.com/jpkrohling/opentelemetry-collector-builder .

[jpkrohling]

Updated link to the repository: https://github.com/observatorium/opentelemetry-collector-builder

Should I use this as base for the doc? I could write a few lines about how to build a custom distribution and briefly mention the builder somewhere.

@kbrockhoff, once you figure out where the docs should go, we might know where to place this here as well.

[jpkrohling]

@tigrannajaryan you can assign this to me.

[jpkrohling]

@pjanotti, @tigrannajaryan, is it OK if I document this in a blog post first, until a decision about an appropriate home for the docs is made?

[tigrannajaryan]

@pjanotti, @tigrannajaryan, is it OK if I document this in a blog post first, until a decision about an appropriate home for the docs is made?

Sounds good to me.

[jpkrohling]

I tried pinging @SergeyKanzhelev and @mtwo on Gitter but got no replies yet. I really want to publish this in the OpenTelemetry publication, but in case it's not possible/desired, let me know and I'll find an alternative place.

[mtwo]

Apologies, I must have missed the notification. Will take a look today.

…

________________________________ From: Juraci Paixão Kröhling <[email protected]> Sent: Wednesday, September 23, 2020 2:09:22 AM To: open-telemetry/opentelemetry-collector <[email protected]> Cc: Morgan McLean <[email protected]>; Mention <[email protected]> Subject: Re: [open-telemetry/opentelemetry-collector] Doc: how to have a custom build and link to contrib repo (#213) I tried pinging @SergeyKanzhelev<https://nam12.safelinks.protection.outlook.com/?url=https%3A%2F%2Fgithub.com%2FSergeyKanzhelev&data=02%7C01%7C%7Cd96d01c3a9584680070908d85fa05c99%7C84df9e7fe9f640afb435aaaaaaaaaaaa%7C1%7C0%7C637364489629403083&sdata=OF4c3TZg%2FMLmhsXmWwfRM9u%2BZCNKE6HYtfCWe1eeEDQ%3D&reserved=0> and @mtwo<https://nam12.safelinks.protection.outlook.com/?url=https%3A%2F%2Fgithub.com%2Fmtwo&data=02%7C01%7C%7Cd96d01c3a9584680070908d85fa05c99%7C84df9e7fe9f640afb435aaaaaaaaaaaa%7C1%7C0%7C637364489629403083&sdata=P4pzajz8tSqihxdSt7Jwb6lpYZRE%2FOSShfhW01THciw%3D&reserved=0> on Gitter but got no replies yet. I really want to publish this in the OpenTelemetry publication, but in case it's not possible/desired, let me know and I'll find an alternative place. — You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub<https://nam12.safelinks.protection.outlook.com/?url=https%3A%2F%2Fgithub.com%2Fopen-telemetry%2Fopentelemetry-collector%2Fissues%2F213%23issuecomment-697237333&data=02%7C01%7C%7Cd96d01c3a9584680070908d85fa05c99%7C84df9e7fe9f640afb435aaaaaaaaaaaa%7C1%7C0%7C637364489629403083&sdata=JOvqMb%2BIfNiBPWKdrCDw2fR3ALzXBPADVs0pTgQ5YWs%3D&reserved=0>, or unsubscribe<https://nam12.safelinks.protection.outlook.com/?url=https%3A%2F%2Fgithub.com%2Fnotifications%2Funsubscribe-auth%2FAAIXLK2FC656A62B7XP25D3SHG3MFANCNFSM4IIHIKPA&data=02%7C01%7C%7Cd96d01c3a9584680070908d85fa05c99%7C84df9e7fe9f640afb435aaaaaaaaaaaa%7C1%7C0%7C637364489629413077&sdata=TJUHRTq9sfdaGUFHZ4nLbI1p8Vd6MnfU47PgEUyeRwg%3D&reserved=0>.

[SergeyKanzhelev]

the process for the blog post is to send draft and request to join OpenTelemetry publication to [email protected]. This is a draft of how to do comms: https://docs.google.com/document/d/1tyy9SJw4ma7qGhjmJrNDBVC98qGxA1ssbYOJY2Jlok4/edit#heading=h.egqr4xhr9jrz - still in progress

[jpkrohling]

Thanks for the doc, I'll follow it and propose a blog post. Is this already public information and I missed it?

[SergeyKanzhelev]

Thanks for the doc, I'll follow it and propose a blog post. Is this already public information and I missed it?

It was never widely publicized. This doc is intended to do this. Last blog post was using this doc to validate it has enough info. Please share your feedback as well

[jpkrohling]

Can this be closed? I think there's now a sufficient documentation about this (blog post + link from the doc).