Skip to content

Commit fe23359

Browse files
chore: update charm libraries (#297)
1 parent ee357b4 commit fe23359

File tree

2 files changed

+10
-4
lines changed

2 files changed

+10
-4
lines changed

lib/charms/tempo_coordinator_k8s/v0/charm_tracing.py

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -69,6 +69,9 @@ def my_tracing_endpoint(self) -> Optional[str]:
6969
- every event as a span (including custom events)
7070
- every charm method call (except dunders) as a span
7171
72+
We recommend that you scale up your tracing provider and relate it to an ingress so that your tracing requests
73+
go through the ingress and get load balanced across all units. Otherwise, if the provider's leader goes down, your tracing goes down.
74+
7275
7376
## TLS support
7477
If your charm integrates with a TLS provider which is also trusted by the tracing provider (the Tempo charm),
@@ -269,7 +272,7 @@ def _remove_stale_otel_sdk_packages():
269272
# Increment this PATCH version before using `charmcraft publish-lib` or reset
270273
# to 0 if you are raising the major API version
271274

272-
LIBPATCH = 2
275+
LIBPATCH = 3
273276

274277
PYDEPS = ["opentelemetry-exporter-otlp-proto-http==1.21.0"]
275278

lib/charms/tempo_coordinator_k8s/v0/tracing.py

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ def __init__(self, *args):
3434
`TracingEndpointRequirer.request_protocols(*protocol:str, relation:Optional[Relation])` method.
3535
Using this method also allows you to use per-relation protocols.
3636
37-
Units of provider charms obtain the tempo endpoint to which they will push their traces by calling
37+
Units of requirer charms obtain the tempo endpoint to which they will push their traces by calling
3838
`TracingEndpointRequirer.get_endpoint(protocol: str)`, where `protocol` is, for example:
3939
- `otlp_grpc`
4040
- `otlp_http`
@@ -44,7 +44,10 @@ def __init__(self, *args):
4444
If the `protocol` is not in the list of protocols that the charm requested at endpoint set-up time,
4545
the library will raise an error.
4646
47-
## Requirer Library Usage
47+
We recommend that you scale up your tracing provider and relate it to an ingress so that your tracing requests
48+
go through the ingress and get load balanced across all units. Otherwise, if the provider's leader goes down, your tracing goes down.
49+
50+
## Provider Library Usage
4851
4952
The `TracingEndpointProvider` object may be used by charms to manage relations with their
5053
trace sources. For this purposes a Tempo-like charm needs to do two things
@@ -107,7 +110,7 @@ def __init__(self, *args):
107110

108111
# Increment this PATCH version before using `charmcraft publish-lib` or reset
109112
# to 0 if you are raising the major API version
110-
LIBPATCH = 2
113+
LIBPATCH = 3
111114

112115
PYDEPS = ["pydantic"]
113116

0 commit comments

Comments
 (0)