Fix automatic APM instrumentation for JS tracer. Add diagnostic logging to APM configurators. Update APM instrumentation docs #388
Conversation
…ng to APM configurators. Update APM instrumentation docs
nikita-tkachenko-datadog
added
the
changelog/Fixed
|
|
||
| @Override | ||
| public Map<String, String> configure(DatadogTracerJobProperty<?> tracerConfig, Node node, FilePath workspacePath, Map<String, String> envs, TaskListener listener) throws Exception { | ||
| String nodeVersion = workspacePath.act(new ShellCommandCallable(Collections.emptyMap(), GET_NPM_VERSION_TIMEOUT_MILLIS, "npm", "-v")); |
There was a problem hiding this comment.
If npm is not installed, would this return an exception?
There was a problem hiding this comment.
Yep, it'll throw an exception that will be caught and logged in the calling class
| listener.getLogger().println("[datadog] Configuring DD JS tracer: got npm version " + nodeVersion + " from " + workspacePath + " on " + node); | ||
|
|
||
| FilePath datadogPath = workspacePath.child(".datadog"); | ||
| datadogPath.mkdirs(); |
There was a problem hiding this comment.
Do we know if the plugin has permissions to create folders?
There was a problem hiding this comment.
It has, and we only do things inside the job's workspace
|
|
||
| // we install dd-trace as a "global" package | ||
| // (otherwise, doing SCM checkout might rollback the changes to package.json, and any subsequent `npm install` calls will result in removing the package) | ||
| String installTracerOutput = workspacePath.act(new ShellCommandCallable(environment, INSTALL_TRACER_TIMEOUT_MILLIS, "npm", "install", "-g", "dd-trace")); |
There was a problem hiding this comment.
Could we have permissions issues?
There was a problem hiding this comment.
The "global" package naming is a bit misleading here - what this means is we are not installing it inside the repo (because subsequent SCM checkout would overwrite this) and instead we install it inside the .datadog folder which we create inside the job's workspace - where we are allowed to write.
We could have a permissions issue if the OS user that runs the Jenkins agent is not allowed to execute npm, but I don't think there's anything we can do in this case other than log an error.
nikita-tkachenko-datadog
deleted the
nikita-tkachenko/js-apm-configuration-fix
branch
Requirements for Contributing to this repository
What does this PR do?
Description of the Change
Alternate Designs
Possible Drawbacks
Verification Process
Additional Notes
Release Notes
Review checklist (to be filled by reviewers)
changelog/label attached. If applicable it should have thebackward-incompatiblelabel attached.do-not-merge/label attached.kind/andseverity/labels attached at least.