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

Fix Javadoc about EnvVarResource #894

Merged
merged 2 commits into from
Feb 20, 2020
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@

/**
* Provides a framework for detection of resource information from the environment variable
* "OC_RESOURCE_LABELS".
* "OTEL_RESOURCE_LABELS".
*
* @since 0.1.0
*/
Expand All @@ -40,7 +40,7 @@ public final class EnvVarResource {
private EnvVarResource() {}

/**
* Returns a {@link Resource}. This resource information is loaded from the OC_RESOURCE_LABELS
* Returns a {@link Resource}. This resource information is loaded from the OTEL_RESOURCE_LABELS
* environment variable.
*
* @return a {@code Resource}.
Expand All @@ -51,9 +51,9 @@ public static Resource getResource() {
}

/*
* Creates a label map from the OC_RESOURCE_LABELS environment variable.
* Creates a label map from the OTEL_RESOURCE_LABELS environment variable.
*
* <p>OC_RESOURCE_LABELS: A comma-separated list of labels describing the source in more detail,
* <p>OTEL_RESOURCE_LABELS: A comma-separated list of labels describing the source in more detail,
* e.g. “key1=val1,key2=val2”. Domain names and paths are accepted as label keys. Values may be
* quoted or unquoted in general. If a value contains whitespaces, =, or " characters, it must
* always be quoted.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -25,8 +25,8 @@
* <p>One environment variables is used to populate resource information:
*
* <ul>
* <li>OC_RESOURCE_LABELS: A comma-separated list of labels describing the source in more detail,
* e.g. “key1=val1,key2=val2”. The allowed character set is appropriately constrained.
* <li>OTEL_RESOURCE_LABELS: A comma-separated list of labels describing the source in more
* detail, e.g. “key1=val1,key2=val2”. The allowed character set is appropriately constrained.
* </ul>
*
* <p>Label keys, and label values MUST contain only printable ASCII (codes between 32 and 126,
Expand Down