[documentation] Ruby documentation audit #772
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
delner
reviewed
Jul 8, 2019
ivoanjo
added a commit
that referenced
this pull request
Feb 24, 2023
**What does this PR do?**: This PR adds the following tip to the error message that customers see when trying to enable profiling but the `pkg-config` system tool is missing: > (Tip: When fixing this, ensure `pkg-config` is installed **before** > running `bundle install`, and remember to clear any installed gems > cache). We've had a couple of customers so far run into this issue -- they install `pkg-config`, and can see it running on their container, but they still see the error, because when `bundle install` runs, the tool is not there yet. Hopefully this tip will avoid other customers running into this issue. **Motivation**: Improve customer UX when enabling the profiler. **Additional Notes**: I've been considering reimplementing what we need out of `pkg-config` so that we stop requiring this tool but for now hopefully this reduces the number of frustrated customers due to this problem. **How to test the change?**: The easiest way to test this is to use one of our development Ruby images, and just delete `pkg-config` from it using ``rm `which pkg-config` ``. If then you run `bundle exec rake clean compile` and then try to run the profiler, you should see the error popping up as a log: ``` $ DD_PROFILING_ENABLED=true bundle exec ddtracerb exec ruby -e "sleep" W, [2023-02-24T10:33:59.671680 #772] WARN -- ddtrace: [ddtrace] Profiling was requested but is not supported, profiling disabled: Your ddtrace installation is missing support for the Continuous Profiler because the `pkg-config` system tool is missing. This issue can usually be fixed by installing one of the following: the `pkg-config` package on Homebrew and Debian/Ubuntu-based Linux; the `pkgconf` package on Arch and Alpine-based Linux; the `pkgconf-pkg-config` package on Fedora/Red Hat-based Linux. (Tip: When fixing this, ensure `pkg-config` is installed **before** running `bundle install`, and remember to clear any installed gem caches). For help solving this issue, please contact Datadog support at <https://docs.datadoghq.com/help/>. You can also check out the Continuous Profiler troubleshooting page at <https://dtdg.co/ruby-profiler-troubleshooting>. ```
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This is my audit to make sure that everything that exists currently in https://docs.datadoghq.com/tracing/setup/ruby/ is added here. Also did some small grammar and style updates to make sure this doc reflects well into the documentation site.
Staging link: https://docs-staging.datadoghq.com/gus/ruby-doc/tracing/setup/ruby/, created in this PR.
The staging link reflects what is currently in this file and will update once this PR is merged in.