Skip to content

Commit 8951ae8

Browse files
authored
[chore] : Add local test steps to contributing guide (open-telemetry#12736)
#### Documentation Contributing doc updated to show steps required to build & run the collector locally. I am unsure if this is too obvious to be stated? I personally had to ask around how to do this when making some contribution in the past!
1 parent 40cb530 commit 8951ae8

File tree

1 file changed

+25
-0
lines changed

1 file changed

+25
-0
lines changed

CONTRIBUTING.md

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -301,6 +301,31 @@ During the collector release process, all `./chloggen/*.yaml` files are transcri
301301

302302
Alternatively, copy `./.chloggen/TEMPLATE.yaml`, or just create your file from scratch.
303303

304+
## Local Testing
305+
306+
To manually test your changes, follow these steps to build and run the Collector
307+
locally. Ensure that you execute these commands from the root of the repository:
308+
309+
1. Build the Collector:
310+
311+
```shell
312+
make otelcorecol
313+
```
314+
315+
2. Run the Collector with a local configuration file:
316+
317+
```shell
318+
./bin/otelcorecol_<os>_<arch> --config ./examples/local/otel-config.yaml
319+
```
320+
321+
The actual name of the binary will depend on your platform, adjust accordingly
322+
(e.g., `./bin/otelcorecol_darwin_arm64`).
323+
324+
Replace `otel-config.yaml` with the appropriate configuration file as needed.
325+
326+
3. Verify that your changes are reflected in the Collector's behavior by testing
327+
it against the provided configuration.
328+
304329
## Membership, Roles, and Responsibilities
305330

306331
### Membership levels

0 commit comments

Comments
 (0)