Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[exporter/fileexporter] provide additional documentation for the working setup of the file exporter #20767

Merged
merged 2 commits into from
May 15, 2023

Conversation

atingchen
Copy link
Contributor

@atingchen atingchen commented Apr 9, 2023

Description:

To address the issue of the official OpenTelemetry collector-contrib container not having a writable filesystem by default due to its construction with a special from scratch layer, users will need to create a writable directory for the file exporter's path. This can potentially be done by creating writable volumes or creating a custom image.

In order to help users better utilize the file exporter, we are working on providing guidance based on the OpenTelemetry operator.

Link to tracking Issue:
#20279

Testing:
N/A
Documentation:
provide additional documentation for the working setup of the file exporter.

@atingchen atingchen requested review from a team and kovrus April 9, 2023 06:32
@runforesight
Copy link

runforesight bot commented Apr 9, 2023

Foresight Summary

    
Major Impacts

build-and-test-windows duration(7 seconds) has decreased 31 minutes 12 seconds compared to main branch avg(31 minutes 19 seconds).
View More Details

⭕  build-and-test-windows workflow has finished in 7 seconds (31 minutes 12 seconds less than main branch avg.) and finished at 9th Apr, 2023.


Job Failed Steps Tests
windows-unittest-matrix -     🔗  N/A See Details
windows-unittest -     🔗  N/A See Details

✅  telemetrygen workflow has finished in 1 minute 12 seconds and finished at 9th Apr, 2023.


Job Failed Steps Tests
build-dev -     🔗  N/A See Details
publish-latest -     🔗  N/A See Details
publish-stable -     🔗  N/A See Details

✅  check-links workflow has finished in 1 minute 45 seconds (⚠️ 47 seconds more than main branch avg.) and finished at 9th Apr, 2023.


Job Failed Steps Tests
changed files -     🔗  N/A See Details
check-links -     🔗  N/A See Details

✅  changelog workflow has finished in 2 minutes 19 seconds and finished at 9th Apr, 2023.


Job Failed Steps Tests
changelog -     🔗  N/A See Details

✅  e2e-tests workflow has finished in 13 minutes 39 seconds and finished at 9th Apr, 2023.


Job Failed Steps Tests
kubernetes-test (v1.26.0) -     🔗  N/A See Details
kubernetes-test (v1.24.7) -     🔗  N/A See Details
kubernetes-test (v1.25.3) -     🔗  N/A See Details
kubernetes-test (v1.23.13) -     🔗  N/A See Details

✅  prometheus-compliance-tests workflow has finished in 12 minutes 48 seconds (⚠️ 6 minutes 31 seconds more than main branch avg.) and finished at 9th Apr, 2023.


Job Failed Steps Tests
prometheus-compliance-tests -     🔗  N/A See Details

✅  load-tests workflow has finished in 15 minutes 14 seconds (⚠️ 4 minutes 53 seconds more than main branch avg.) and finished at 9th Apr, 2023.


Job Failed Steps Tests
setup-environment -     🔗  N/A See Details
loadtest (TestIdleMode) -     🔗  N/A See Details
loadtest (TestBallastMemory|TestLog10kDPS) -     🔗  N/A See Details
loadtest (TestMetric10kDPS|TestMetricsFromFile) -     🔗  N/A See Details
loadtest (TestMetricResourceProcessor|TestTrace10kSPS) -     🔗  N/A See Details
loadtest (TestTraceNoBackend10kSPS|TestTrace1kSPSWithAttrs) -     🔗  N/A See Details
loadtest (TestTraceBallast1kSPSWithAttrs|TestTraceBallast1kSPSAddAttrs) -     🔗  N/A See Details
loadtest (TestTraceAttributesProcessor) -     🔗  N/A See Details

✅  build-and-test workflow has finished in 38 minutes 8 seconds (8 minutes 27 seconds less than main branch avg.) and finished at 9th Apr, 2023.


Job Failed Steps Tests
setup-environment -     🔗  N/A See Details
build-examples -     🔗  N/A See Details
check-codeowners -     🔗  N/A See Details
checks -     🔗  N/A See Details
check-collector-module-version -     🔗  N/A See Details
correctness-traces -     🔗  N/A See Details
correctness-metrics -     🔗  N/A See Details
integration-tests -     🔗  N/A See Details
lint-matrix (receiver-0) -     🔗  N/A See Details
lint-matrix (receiver-1) -     🔗  N/A See Details
lint-matrix (processor) -     🔗  N/A See Details
lint-matrix (exporter) -     🔗  N/A See Details
lint-matrix (extension) -     🔗  N/A See Details
lint-matrix (connector) -     🔗  N/A See Details
lint-matrix (internal) -     🔗  N/A See Details
lint-matrix (other) -     🔗  N/A See Details
unittest-matrix (1.20, receiver-0) -     🔗  N/A See Details
unittest-matrix (1.20, receiver-1) -     🔗  N/A See Details
unittest-matrix (1.20, processor) -     🔗  N/A See Details
unittest-matrix (1.20, exporter) -     🔗  N/A See Details
unittest-matrix (1.20, extension) -     🔗  N/A See Details
unittest-matrix (1.20, connector) -     🔗  N/A See Details
unittest-matrix (1.20, internal) -     🔗  N/A See Details
unittest-matrix (1.20, other) -     🔗  N/A See Details
unittest-matrix (1.19, receiver-0) -     🔗  N/A See Details
unittest-matrix (1.19, receiver-1) -     🔗  N/A See Details
unittest-matrix (1.19, processor) -     🔗  N/A See Details
unittest-matrix (1.19, exporter) -     🔗  N/A See Details
unittest-matrix (1.19, extension) -     🔗  N/A See Details
unittest-matrix (1.19, connector) -     🔗  N/A See Details
unittest-matrix (1.19, internal) -     🔗  N/A See Details
unittest-matrix (1.19, other) -     🔗  N/A See Details
lint -     🔗  N/A See Details
unittest (1.20) -     🔗  N/A See Details
unittest (1.19) -     🔗  N/A See Details
cross-compile (darwin, amd64) -     🔗  N/A See Details
cross-compile (darwin, arm64) -     🔗  N/A See Details
cross-compile (linux, 386) -     🔗  N/A See Details
cross-compile (linux, amd64) -     🔗  N/A See Details
cross-compile (linux, arm) -     🔗  N/A See Details
cross-compile (linux, arm64) -     🔗  N/A See Details
cross-compile (linux, ppc64le) -     🔗  N/A See Details
cross-compile (windows, 386) -     🔗  N/A See Details
cross-compile (windows, amd64) -     🔗  N/A See Details
build-package (deb) -     🔗  N/A See Details
build-package (rpm) -     🔗  N/A See Details
windows-msi -     🔗  N/A See Details
publish-check -     🔗  N/A See Details
publish-dev -     🔗  N/A See Details
publish-stable -     🔗  N/A See Details
rotate-milestone -     🔗  N/A See Details

🔎 See details on Foresight

*You can configure Foresight comments in your organization settings page.

@atoulme
Copy link
Contributor

atoulme commented Apr 17, 2023

special from scratch layer

Nothing special about that :) just a good practice imo to reduce the security issues you can encounter.

@atingchen
Copy link
Contributor Author

special from scratch layer

Nothing special about that :) just a good practice imo to reduce the security issues you can encounter.

Hi, @atoulme. Thanks for your comments on the PR. I have incorporate them all.

@atingchen atingchen force-pushed the feature/add-document branch 2 times, most recently from e69198c to 8da175f Compare April 26, 2023 13:36
@atingchen atingchen force-pushed the feature/add-document branch from 8da175f to ff22ecf Compare May 8, 2023 06:48
@atingchen
Copy link
Contributor Author

@djaglowski Hi, Daniel~I hope you can give me some advice if you have time.

Copy link
Member

@djaglowski djaglowski left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM. Thanks @atingchen!

@djaglowski djaglowski merged commit 23eeb67 into open-telemetry:main May 15, 2023
@github-actions github-actions bot added this to the next release milestone May 15, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants