Skip to content

Commit 86268e7

Browse files
dmathieuTylerHelmuthchristos68kmowiesflorianl
authored
Introduce eBPF Profiler distribution (#908)
* add new ebpf-profiler distribution * add changelog entry * mark ebpf-profiler as a valid component * only release on amd for now * enable cgo * don't rely on scratch image * use a custom config file for profiler * run tests with profiles feature flags * run ebpf container privileged * run container as root * mount debugfs? * add dash to org name * add ebpf-profiler exception for components to include * it's connector and extensions that must facilitate collection and processing * Update distributions/otelcol-ebpf-profiler/README.md Co-authored-by: Tyler Helmuth <12352919+TylerHelmuth@users.noreply.github.com> * Update .github/workflows/release-ebpf-profiler.yaml Co-authored-by: Christos Kalkanis <christos.kalkanis@elastic.co> * add arm64 * remove unneeded name * Update .github/workflows/ci-goreleaser-ebpf-profiler.yaml Co-authored-by: Florian Lehner <florianl@users.noreply.github.com> * add extension to config_file parameter * move the config option to be after all the docker ones * remove arm64 * use custom ld flags * add custom go tags * only keep the extldflags ldflag * remove unneeded arm version * document the need for cgo * don't release ebpf images yet * refine cgo doc * remove arm64 from goreleaser * add glibc version requirement --------- Co-authored-by: Tyler Helmuth <12352919+TylerHelmuth@users.noreply.github.com> Co-authored-by: Christos Kalkanis <christos.kalkanis@elastic.co> Co-authored-by: Moritz Wiesinger <moritz.wiesinger@dynatrace.com> Co-authored-by: Florian Lehner <florianl@users.noreply.github.com>
1 parent dc6bc30 commit 86268e7

File tree

13 files changed

+270
-16
lines changed

13 files changed

+270
-16
lines changed

‎.chloggen/ebpf-profiler.yaml‎

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
# Use this changelog template to create an entry for release notes.
2+
3+
# One of 'breaking', 'deprecation', 'new_component', 'enhancement', 'bug_fix'
4+
change_type: new_component
5+
6+
# The name of the component, or a single word describing the area of concern, (e.g. otlpreceiver)
7+
component: otelcol-ebpf-profiler
8+
9+
# A brief description of the change. Surround your text with quotes ("") if it needs to start with a backtick (`).
10+
note: Introduce eBPF Profiler Distribution
11+
12+
# One or more tracking issues or pull requests related to the change
13+
issues: [908]
14+
15+
# (Optional) One or more lines of additional information to render under the primary note.
16+
# These lines will be padded with 2 spaces and then inserted directly into the document.
17+
# Use pipe (|) for multiline entries.
18+
subtext:
19+
20+
# Optional: The change log or logs in which this entry should be included.
21+
# e.g. '[user]' or '[user, api]'
22+
# Include 'user' if the change is relevant to end users.
23+
# Include 'api' if there is a change to a library API.
24+
# Default: '[user]'
25+
change_logs: [user]

‎.github/CODEOWNERS‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,9 @@
66
#
77
# Learn about membership in OpenTelemetry community:
88
# https://github.com/open-telemetry/community/blob/main/community-membership.md
9-
#
109
#
11-
# Learn about CODEOWNERS file format:
10+
#
11+
# Learn about CODEOWNERS file format:
1212
# https://help.github.com/en/articles/about-code-owners
1313
#
1414

@@ -18,4 +18,4 @@
1818
/distributions/otelcol-otlp/manifest.yaml @open-telemetry/collector-releases-approvers @open-telemetry/collector-approvers
1919
/distributions/otelcol-contrib/manifest.yaml @open-telemetry/collector-releases-approvers @open-telemetry/collector-contrib-approvers
2020
/distributions/otelcol-k8s/manifest.yaml @open-telemetry/collector-releases-approvers @open-telemetry/helm-approvers @open-telemetry/operator-approvers
21-
21+
/distributions/otelcol-ebpf-profiler @open-telemetry/collector-releases-approvers @open-telemetry/ebpf-profiler-approvers

‎.github/workflows/ci-goreleaser-ebpf-profiler.yaml‎

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
name: CI - eBPF Profiler - GoReleaser
2+
3+
on:
4+
merge_group:
5+
push:
6+
branches: [main]
7+
paths:
8+
- "distributions/otelcol-ebpf-profiler/**"
9+
- "cmd/**"
10+
- ".github/**"
11+
- "scripts/**"
12+
- "Makefile"
13+
- "go.mod"
14+
- "go.sum"
15+
pull_request:
16+
branches: [main]
17+
paths:
18+
- "distributions/otelcol-ebpf-profiler/**"
19+
- "cmd/**"
20+
- ".github/**"
21+
- "scripts/**"
22+
- "Makefile"
23+
- "go.mod"
24+
- "go.sum"
25+
26+
jobs:
27+
check-goreleaser:
28+
name: CI - eBPF Profiler - GoReleaser
29+
uses: ./.github/workflows/base-ci-goreleaser.yaml
30+
with:
31+
distribution: otelcol-ebpf-profiler
32+
config_file: ebpf-profiler-config.yaml
33+
docker_run_options: '--privileged --pid=host -v /sys/kernel/debug/:/sys/kernel/debug/:ro'
34+
otelcol_run_options: '--feature-gates=service.profilesSupport'
35+
goos: '[ "linux" ]'
36+
goarch: '[ "amd64" ]'
37+
secrets: inherit

‎.github/workflows/scripts/bump-versions.sh‎

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
#!/bin/bash
22
set -e
33
# This script reads current versions and takes optional next versions, and updates the
4-
# version in the specified files. If next version is not provided, it will infer the
5-
# next semantic version (e.g. v0.110.0 -> v0.111.0 or v1.16.0 -> v1.17.0) based on the
4+
# version in the specified files. If next version is not provided, it will infer the
5+
# next semantic version (e.g. v0.110.0 -> v0.111.0 or v1.16.0 -> v1.17.0) based on the
66
# current version(s) read in.
77

88
# List of files to update
@@ -11,6 +11,7 @@ manifest_files=(
1111
"distributions/otelcol/manifest.yaml"
1212
"distributions/otelcol-k8s/manifest.yaml"
1313
"distributions/otelcol-otlp/manifest.yaml"
14+
"distributions/otelcol-ebpf-profiler/manifest.yaml"
1415
)
1516

1617
# Function to display usage
@@ -202,7 +203,7 @@ create_pr() {
202203

203204
gh pr create --title "[chore] Prepare release $next_version" \
204205
--body "This PR updates the version from $current_version to $next_version" \
205-
--base main --head "$branch_name" --draft
206+
--base main --head "$branch_name" --draft
206207
}
207208

208209
# TODO: Once Collector 1.0 is released, we can consider removing the

‎Makefile‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ TOOLS_BIN_NAMES := $(addprefix $(TOOLS_BIN_DIR)/, $(notdir $(shell echo $(TOOLS_
1616
CHLOGGEN := $(TOOLS_BIN_DIR)/chloggen
1717
CHLOGGEN_CONFIG := .chloggen/config.yaml
1818

19-
DISTRIBUTIONS ?= "otelcol,otelcol-contrib,otelcol-k8s,otelcol-otlp"
19+
DISTRIBUTIONS ?= "otelcol,otelcol-contrib,otelcol-k8s,otelcol-otlp,otelcol-ebpf-profiler"
2020

2121
ci: check build
2222
check: ensure-goreleaser-up-to-date validate-components

‎README.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,7 @@ Current list of distributions:
1818
- [OpenTelemetry Collector Contrib (also known as "otelcol-contrib")](./distributions/otelcol-contrib)
1919
- [OpenTelemetry Collector for Kubernetes (also known as "otelcol-k8s")](./distributions/otelcol-k8s)
2020
- [OpenTelemetry Collector OTLP (also known as "otelcol-otlp")](./distributions/otelcol-otlp)
21+
- [OpenTelemetry Collector eBPF Profiler (also known as "otelcol-ebpf-profiler")](./distributions/otelcol-ebpf-profiler)
2122

2223
## Community
2324

‎cmd/goreleaser/internal/configure.go‎

Lines changed: 28 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -29,14 +29,15 @@ import (
2929
)
3030

3131
const (
32-
armArch = "arm"
33-
coreDistro = "otelcol"
34-
contribDistro = "otelcol-contrib"
35-
k8sDistro = "otelcol-k8s"
36-
otlpDistro = "otelcol-otlp"
37-
ghcr = "ghcr.io/open-telemetry/opentelemetry-collector-releases"
38-
binaryNamePrefix = "otelcol"
39-
imageNamePrefix = "opentelemetry-collector"
32+
armArch = "arm"
33+
coreDistro = "otelcol"
34+
contribDistro = "otelcol-contrib"
35+
k8sDistro = "otelcol-k8s"
36+
otlpDistro = "otelcol-otlp"
37+
ebpfProfilerDistro = "otelcol-ebpf-profiler"
38+
ghcr = "ghcr.io/open-telemetry/opentelemetry-collector-releases"
39+
binaryNamePrefix = "otelcol"
40+
imageNamePrefix = "opentelemetry-collector"
4041
)
4142

4243
var (
@@ -45,6 +46,7 @@ var (
4546
winContainerArchs = []string{"amd64"}
4647
darwinArchs = []string{"amd64", "arm64"}
4748
k8sArchs = []string{"amd64", "arm64", "ppc64le", "s390x"}
49+
ebpfProfilerArchs = []string{"amd64"}
4850

4951
imageRepos = []string{ghcr}
5052

@@ -141,6 +143,22 @@ var (
141143
newContainerImageManifests(d.name, "linux", k8sArchs, containerImageOptions{}),
142144
)
143145
}).WithDefaultArchives().WithDefaultChecksum().WithDefaultSigns().WithDefaultDockerSigns().WithDefaultSBOMs().Build()
146+
147+
// ebpf-profiler distro
148+
ebpfProfilerDist = newDistributionBuilder(ebpfProfilerDistro).WithConfigFunc(func(d *distribution) {
149+
d.buildConfigs = []buildConfig{
150+
&fullBuildConfig{targetOS: "linux", targetArch: ebpfProfilerArchs},
151+
}
152+
d.containerImages = slices.Concat(
153+
newContainerImages(d.name, "linux", ebpfProfilerArchs, containerImageOptions{}),
154+
)
155+
d.containerImageManifests = slices.Concat(
156+
newContainerImageManifests(d.name, "linux", ebpfProfilerArchs, containerImageOptions{}),
157+
)
158+
d.enableCgo = true
159+
d.ldFlags = "-extldflags=-static"
160+
d.goTags = "osusergo,netgo"
161+
}).WithDefaultArchives().WithDefaultChecksum().WithDefaultSigns().WithDefaultDockerSigns().WithDefaultSBOMs().Build()
144162
)
145163

146164
type buildConfig interface {
@@ -610,6 +628,8 @@ func BuildDist(dist string, onlyBuild bool) config.Project {
610628
return otlpDist.BuildProject()
611629
case k8sDistro:
612630
return k8sDist.BuildProject()
631+
case ebpfProfilerDistro:
632+
return ebpfProfilerDist.BuildProject()
613633
case contribDistro:
614634
if onlyBuild {
615635
return contribBuildOnlyDist.BuildProject()

‎distributions/otelcol-ebpf-profiler/.goreleaser.yaml‎

Lines changed: 78 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,78 @@
1+
version: 2
2+
project_name: opentelemetry-collector-releases
3+
env:
4+
- COSIGN_YES=true
5+
- LD_FLAGS=-extldflags=-static
6+
- BUILD_FLAGS=-trimpath
7+
- GO_TAGS=osusergo,netgo
8+
release:
9+
replace_existing_artifacts: true
10+
builds:
11+
- id: otelcol-ebpf-profiler-linux
12+
goos:
13+
- linux
14+
goarch:
15+
- amd64
16+
dir: _build
17+
binary: otelcol-ebpf-profiler
18+
ldflags:
19+
- '{{ .Env.LD_FLAGS }}'
20+
flags:
21+
- '{{ .Env.BUILD_FLAGS }}'
22+
archives:
23+
- id: otelcol-ebpf-profiler
24+
builds:
25+
- otelcol-ebpf-profiler-linux
26+
name_template: '{{ .Binary }}_{{ .Version }}_{{ .Os }}_{{ .Arch }}{{ if .Arm }}v{{ .Arm }}{{ end }}{{ if .Mips }}_{{ .Mips }}{{ end }}'
27+
checksum:
28+
name_template: '{{ .ProjectName }}_otelcol-ebpf-profiler_checksums.txt'
29+
dockers:
30+
- goos: linux
31+
goarch: amd64
32+
dockerfile: Dockerfile
33+
image_templates:
34+
- ghcr.io/open-telemetry/opentelemetry-collector-releases/opentelemetry-collector-ebpf-profiler:{{ .Version }}-amd64
35+
- ghcr.io/open-telemetry/opentelemetry-collector-releases/opentelemetry-collector-ebpf-profiler:latest-amd64
36+
build_flag_templates:
37+
- --pull
38+
- --platform=linux/amd64
39+
- --label=org.opencontainers.image.created={{.Date}}
40+
- --label=org.opencontainers.image.name={{.ProjectName}}
41+
- --label=org.opencontainers.image.revision={{.FullCommit}}
42+
- --label=org.opencontainers.image.version={{.Version}}
43+
- --label=org.opencontainers.image.source={{.GitURL}}
44+
- --label=org.opencontainers.image.licenses=Apache-2.0
45+
use: buildx
46+
docker_manifests:
47+
- name_template: ghcr.io/open-telemetry/opentelemetry-collector-releases/opentelemetry-collector-ebpf-profiler:{{ .Version }}
48+
image_templates:
49+
- ghcr.io/open-telemetry/opentelemetry-collector-releases/opentelemetry-collector-ebpf-profiler:{{ .Version }}-amd64
50+
- name_template: ghcr.io/open-telemetry/opentelemetry-collector-releases/opentelemetry-collector-ebpf-profiler:latest
51+
image_templates:
52+
- ghcr.io/open-telemetry/opentelemetry-collector-releases/opentelemetry-collector-ebpf-profiler:latest-amd64
53+
signs:
54+
- cmd: cosign
55+
args:
56+
- sign-blob
57+
- --output-signature
58+
- ${artifact}.sig
59+
- --output-certificate
60+
- ${artifact}.pem
61+
- ${artifact}
62+
signature: ${artifact}.sig
63+
artifacts: all
64+
certificate: ${artifact}.pem
65+
docker_signs:
66+
- args:
67+
- sign
68+
- ${artifact}
69+
artifacts: all
70+
sboms:
71+
- id: archive
72+
artifacts: archive
73+
- id: package
74+
artifacts: package
75+
monorepo:
76+
tag_prefix: v
77+
partial:
78+
by: target

‎distributions/otelcol-ebpf-profiler/Dockerfile‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
FROM golang:1.23.8
2+
3+
COPY --chmod=755 otelcol-ebpf-profiler /otelcol-ebpf-profiler
4+
ENTRYPOINT ["/otelcol-ebpf-profiler"]

‎distributions/otelcol-ebpf-profiler/README.md‎

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
# OpenTelemetry Collector eBPF Profiling Distribution
2+
3+
This distribution is made specifically to be used as a node agent to gather
4+
profiles on all processes running on the system.
5+
6+
It contains the [eBPF profiler
7+
receiver](https://github.com/open-telemetry/opentelemetry-ebpf-profiler) as
8+
well as a subset of components from [OpenTelemetry Collector
9+
Core](https://github.com/open-telemetry/opentelemetry-collector) and
10+
[OpenTelemetry Collector
11+
Contrib](https://github.com/open-telemetry/opentelemetry-collector-contrib).
12+
13+
## Requirements
14+
15+
### CGO
16+
17+
The use of the foreign language interface to bring in dependencies requires to
18+
set CGO for the eBPF profiler.
19+
To utilize a foreign language interface for incorporating dependencies into the
20+
eBPF profiler, it is essential to configure and enable CGO.
21+
22+
In order to enable CGO, we need a libc on the container.
23+
We use glibc, and the distribution is tested against v2.39.
24+
25+
## Components
26+
27+
The full list of components is available in the [manifest](manifest.yaml).
28+
29+
### Rules for Component Inclusion
30+
31+
- Only includes components from Contrib and Core, except for the ebpf-profiler receiver.
32+
- Only components that are Alpha or higher.
33+
- All processors, connectors, and extensions must facilitate the collection and processing of data that is generated by the eBPF profiler.
34+
- All components must be vendor-neutral.
35+
- Only exporters that use OTLP are allowed.
36+
- To facilitate troubleshooting, the nop, debug, and file exporters are exceptions.

0 commit comments

Comments
 (0)