Package io.opencensus.resource
Class Resource
java.lang.Object
io.opencensus.resource.Resource
- Direct Known Subclasses:
AutoValue_Resource
Resource
represents a resource, which capture identifying information about the entities
for which signals (stats or traces) are reported. It further provides a framework for detection
of resource information from the environment and progressive population as signals propagate from
the core instrumentation library to a backend's exporter.- Since:
- 0.18
-
Field Summary
Fields -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionstatic Resource
Returns aResource
.static Resource
Returns aResource
.private static Resource
createInternal
(String type, Map<String, String> labels) Returns a map of labels that describe the resource.abstract String
getType()
Returns the type identifier for the resource.private static boolean
Determines whether the givenString
is a valid printable ASCII string with a length not exceedMAX_LENGTH
characters.private static boolean
isValidAndNotEmpty
(String name) Determines whether the givenString
is a valid printable ASCII string with a length greater than 0 and not exceedMAX_LENGTH
characters.private static Resource
Returns a new, mergedResource
by merging two resources.static Resource
mergeResources
(List<Resource> resources) Returns aResource
that runs all input resources sequentially and merges their results.parseResourceLabels
(String rawEnvLabels) (package private) static String
parseResourceType
(String rawEnvType) Creates a resource type from the OC_RESOURCE_TYPE environment variable.
-
Field Details
-
MAX_LENGTH
static final int MAX_LENGTH- See Also:
-
OC_RESOURCE_TYPE_ENV
- See Also:
-
OC_RESOURCE_LABELS_ENV
- See Also:
-
LABEL_LIST_SPLITTER
- See Also:
-
LABEL_KEY_VALUE_SPLITTER
- See Also:
-
ERROR_MESSAGE_INVALID_CHARS
- See Also:
-
ERROR_MESSAGE_INVALID_VALUE
- See Also:
-
ENV_TYPE
-
ENV_LABEL_MAP
-
-
Constructor Details
-
Resource
Resource()
-
-
Method Details
-
getType
Returns the type identifier for the resource.- Returns:
- the type identifier for the resource.
- Since:
- 0.18
-
getLabels
Returns a map of labels that describe the resource.- Returns:
- a map of labels.
- Since:
- 0.18
-
createFromEnvironmentVariables
Returns aResource
. This resource information is loaded from the OC_RESOURCE_TYPE and OC_RESOURCE_LABELS environment variables.- Returns:
- a
Resource
. - Since:
- 0.18
-
create
Returns aResource
.- Parameters:
type
- the type identifier for the resource.labels
- a map of labels that describe the resource.- Returns:
- a
Resource
. - Throws:
NullPointerException
- iflabels
is null.IllegalArgumentException
- if type or label key or label value is not a valid printable ASCII string or exceedMAX_LENGTH
characters.- Since:
- 0.18
-
mergeResources
Returns aResource
that runs all input resources sequentially and merges their results. In case a type of label key is already set, the first set value takes precedence.- Parameters:
resources
- a list of resources.- Returns:
- a
Resource
. - Since:
- 0.18
-
createInternal
-
parseResourceType
Creates a resource type from the OC_RESOURCE_TYPE environment variable.OC_RESOURCE_TYPE: A string that describes the type of the resource prefixed by a domain namespace, e.g. “kubernetes.io/container”.
-
parseResourceLabels
-
merge
@Nullable private static Resource merge(@Nullable Resource resource, @Nullable Resource otherResource) Returns a new, mergedResource
by merging two resources. In case of a collision, first resource takes precedence. -
isValid
Determines whether the givenString
is a valid printable ASCII string with a length not exceedMAX_LENGTH
characters.- Parameters:
name
- the name to be validated.- Returns:
- whether the name is valid.
-
isValidAndNotEmpty
Determines whether the givenString
is a valid printable ASCII string with a length greater than 0 and not exceedMAX_LENGTH
characters.- Parameters:
name
- the name to be validated.- Returns:
- whether the name is valid.
-