Package io.opentelemetry.sdk.resources
Class Resource
java.lang.Object
io.opentelemetry.sdk.resources.Resource
Resource
represents a resource, which capture identifying information about the entities
for which signals (stats or traces) are reported.-
Method Summary
Modifier and TypeMethodDescriptionstatic ResourceBuilder
builder()
Returns a newResourceBuilder
instance for creating arbitraryResource
.static Resource
create
(io.opentelemetry.api.common.Attributes attributes) Returns aResource
.static Resource
Returns aResource
.static Resource
empty()
Returns an emptyResource
.<T> T
getAttribute
(io.opentelemetry.api.common.AttributeKey<T> key) Returns the value for a given resource attribute key.abstract io.opentelemetry.api.common.Attributes
Returns a map of attributes that describe the resource.static Resource
Returns the defaultResource
.abstract String
Returns the URL of the OpenTelemetry schema used by this resource.Returns a newResourceBuilder
instance populated with the data of thisResource
.
-
Method Details
-
getDefault
Returns the defaultResource
. This resource contains the default attributes provided by the SDK.- Returns:
- a
Resource
.
-
empty
Returns an emptyResource
. When creating aResource
, it is strongly recommended to start withgetDefault()
instead of this method to include SDK required attributes.- Returns:
- an empty
Resource
.
-
create
Returns aResource
.- Parameters:
attributes
- a map of attributes that describe the resource.- Returns:
- a
Resource
. - Throws:
NullPointerException
- ifattributes
is null.IllegalArgumentException
- if attribute key or attribute value is not a valid printable ASCII string or exceedMAX_LENGTH
characters.
-
create
public static Resource create(io.opentelemetry.api.common.Attributes attributes, @Nullable String schemaUrl) Returns aResource
.- Parameters:
attributes
- a map ofAttributes
that describe the resource.schemaUrl
- The URL of the OpenTelemetry schema used to create this Resource.- Returns:
- a
Resource
. - Throws:
NullPointerException
- ifattributes
is null.IllegalArgumentException
- if attribute key or attribute value is not a valid printable ASCII string or exceedMAX_LENGTH
characters.
-
getSchemaUrl
Returns the URL of the OpenTelemetry schema used by this resource. May be null.- Returns:
- An OpenTelemetry schema URL.
- Since:
- 1.4.0
-
getAttributes
public abstract io.opentelemetry.api.common.Attributes getAttributes()Returns a map of attributes that describe the resource.- Returns:
- a map of attributes.
-
getAttribute
Returns the value for a given resource attribute key.- Returns:
- the value of the attribute with the given key
-
merge
Returns a new, mergedResource
by merging the currentResource
with theother
Resource
. In case of a collision, the "other"Resource
takes precedence.- Parameters:
other
- theResource
that will be merged withthis
.- Returns:
- the newly merged
Resource
.
-
builder
Returns a newResourceBuilder
instance for creating arbitraryResource
.- Since:
- 1.1.0
-
toBuilder
Returns a newResourceBuilder
instance populated with the data of thisResource
.- Since:
- 1.1.0
-