docs(java): add Javadoc to OpenTelemetryConfiguration#1261
Open
S-anskriti wants to merge 1 commit intojenkinsci:mainfrom
Open
docs(java): add Javadoc to OpenTelemetryConfiguration#1261S-anskriti wants to merge 1 commit intojenkinsci:mainfrom
S-anskriti wants to merge 1 commit intojenkinsci:mainfrom
Conversation
Add missing class-level and method-level Javadoc to OpenTelemetryConfiguration, documenting: - Constructor parameters and validation rules - getEndpoint(): OTLP URL format and empty Optional semantics - getServiceName(): relationship to service.name resource attribute - getServiceNamespace(): relationship to service.namespace resource attribute - getAuthentication(): supported authentication mechanisms - getTrustedCertificatesPem(): when and how to use custom TLS certs - getDisabledResourceProviders(): mapping to otel.java.disabled.resource.providers No functional changes.
Author
|
Hi @shivaylamba and @krisstern . This is my second contribution to the plugin as part of my GSoC 2026 application for the OpenTelemetry project. Would love any feedback! |
This file contains hidden or 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
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.
Summary
Adds missing class-level and method-level Javadoc to
OpenTelemetryConfiguration.java.Motivation
The public API of
OpenTelemetryConfigurationhad no Javadoc on theclass, constructor, or getter methods, making it harder for new
contributors to understand parameter expectations, return value
semantics (especially the empty
Optionalcases), and the relationshipbetween plugin settings and OpenTelemetry SDK properties.
Changes
@paramfor all 7 parametersincluding the validation rule on the endpoint format
getEndpoint()— OTLP URL format and empty Optional semanticsgetServiceName()— relationship toservice.nameresource attributegetServiceNamespace()— relationship toservice.namespaceresource attributegetAuthentication()— supported authentication mechanismsgetTrustedCertificatesPem()— when and how to use custom TLS certsgetDisabledResourceProviders()— maps tootel.java.disabled.resource.providersTesting
Verified
mvn compilesucceeds with no new warnings.No functional changes.
Note: I am a GSoC 2026 applicant interested in the
Use OpenTelemetry for Jenkins Jobs on ci.jenkins.io
project.