Make packages internal to separate public and internal APIs

[rockdaboot]

Every package that is not meant to be used externally, should be made private explicitly.

We possibly start making everything private (= putting under internal/) except

• libpf/
• reporter/
• tracer/
• hostmetadata/
• times/
• tracehandler/
  and then iterate on further improvements/restrictions from there.

It would be good to know, which parts of the profiler code needs to be accessible from custom agents (@felixge @brancz).

[florianl]

It might be worth consindering to make github.com/open-telemetry/opentelemetry-ebpf-profiler/host private. This package provides types that are only internal to the agent and should not be part of a public API. Besides the unfortunate naming, using the package github.com/open-telemetry/opentelemetry-ebpf-profiler/host without having more insight knowledge might just be confusing.

Is there an overall idea how public APIs for public packages should look like, that can be discussed upfront?

[rockdaboot]

It might be worth consindering to make github.com/open-telemetry/opentelemetry-ebpf-profiler/host private.

👍 Removed from the list

[felixge]

Thanks for raising this. We'll discuss it and provide feedback. Sorry for the delay.

[Gandem]

We're currently using util to be able to implement the Reporter interface which requires util.SourceLineno:

opentelemetry-ebpf-profiler/reporter/iface.go

Lines 75 to 76 in dd98f70

	FrameMetadata(fileID libpf.FileID, addressOrLine libpf.AddressOrLineno,
	lineNumber util.SourceLineno, functionOffset uint32, functionName, filePath string)

Would it be possible to also expose util or alternatively move util.SourceLineno to a publicly exported package?

[rockdaboot]

We're currently using util to be able to implement the Reporter interface which requires util.SourceLineno:

@Gandem Thanks for pointing out, makes much sense. See #156