Skip to content

Commit f49e5c5

Browse files
committed
chore: telemetry updates for the deployments
Keycloak example will be updated to 26.2.5, which contains support for telemetry. The committed setup changes are required for the Keycloak update. Due to the Keycloak update to 26.2.5, jaeger will also need to be updated. It isn't part of the deployment, but the expected docker image is jaegertracing/jaeger:2.7.0 (which is supported by Keycloak 26.2.5). The jaeger update also brings changes in oCIS. Previous 6831 port in jaeger isn't available in recent versions (particularly 2.7.0), and has changed to port 4317, which supports the "otlp" tracing type in oCIS. No code change is needed.
1 parent a5ebdf0 commit f49e5c5

File tree

9 files changed

+30
-28
lines changed

9 files changed

+30
-28
lines changed

deployments/examples/oc10_ocis_parallel/monitoring_tracing/docker-compose-additions.yml

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,13 +6,12 @@ services:
66
environment:
77
# tracing
88
OCIS_TRACING_ENABLED: "true"
9-
OCIS_TRACING_TYPE: "jaeger"
10-
OCIS_TRACING_ENDPOINT: jaeger-agent:6831
9+
OCIS_TRACING_TYPE: "otlp"
10+
OCIS_TRACING_ENDPOINT: jaeger:4317
1111
# metrics
1212
# if oCIS runs as a single process, all <debug>/metrics endpoints
1313
# will expose the same metrics, so it's sufficient to query one endpoint
1414
PROXY_DEBUG_ADDR: 0.0.0.0:9205
1515

1616
networks:
1717
ocis-net:
18-
external: true

deployments/examples/ocis_full/monitoring_tracing/monitoring-oo.yml

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,8 @@ services:
55
environment:
66
# tracing
77
OCIS_TRACING_ENABLED: "true"
8-
OCIS_TRACING_TYPE: "jaeger"
9-
OCIS_TRACING_ENDPOINT: jaeger-agent:6831
8+
OCIS_TRACING_TYPE: "otlp"
9+
OCIS_TRACING_ENDPOINT: jaeger:4317
1010
# metrics
1111
# if oCIS runs as a single process, all <debug>/metrics endpoints
1212
# will expose the same metrics, so it's sufficient to query one endpoint
@@ -16,11 +16,10 @@ services:
1616
environment:
1717
# tracing
1818
OCIS_TRACING_ENABLED: "true"
19-
OCIS_TRACING_TYPE: "jaeger"
20-
OCIS_TRACING_ENDPOINT: jaeger-agent:6831
19+
OCIS_TRACING_TYPE: "otlp"
20+
OCIS_TRACING_ENDPOINT: jaeger:4317
2121
# metrics
2222
COLLABORATION_DEBUG_ADDR: 0.0.0.0:9304
2323

2424
networks:
2525
ocis-net:
26-
external: true

deployments/examples/ocis_full/monitoring_tracing/monitoring.yml

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,8 @@ services:
55
environment:
66
# tracing
77
OCIS_TRACING_ENABLED: "true"
8-
OCIS_TRACING_TYPE: "jaeger"
9-
OCIS_TRACING_ENDPOINT: jaeger-agent:6831
8+
OCIS_TRACING_TYPE: "otlp"
9+
OCIS_TRACING_ENDPOINT: jaeger:4317
1010
# metrics
1111
# if oCIS runs as a single process, all <debug>/metrics endpoints
1212
# will expose the same metrics, so it's sufficient to query one endpoint
@@ -16,11 +16,10 @@ services:
1616
environment:
1717
# tracing
1818
OCIS_TRACING_ENABLED: "true"
19-
OCIS_TRACING_TYPE: "jaeger"
20-
OCIS_TRACING_ENDPOINT: jaeger-agent:6831
19+
OCIS_TRACING_TYPE: "otlp"
20+
OCIS_TRACING_ENDPOINT: jaeger:4317
2121
# metrics
2222
COLLABORATION_DEBUG_ADDR: 0.0.0.0:9304
2323

2424
networks:
2525
ocis-net:
26-
external: true

deployments/examples/ocis_hello/monitoring_tracing/docker-compose-additions.yml

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,13 +6,12 @@ services:
66
environment:
77
# tracing
88
OCIS_TRACING_ENABLED: "true"
9-
OCIS_TRACING_TYPE: "jaeger"
10-
OCIS_TRACING_ENDPOINT: jaeger-agent:6831
9+
OCIS_TRACING_TYPE: "otlp"
10+
OCIS_TRACING_ENDPOINT: jaeger:4317
1111
# metrics
1212
# if oCIS runs as a single process, all <debug>/metrics endpoints
1313
# will expose the same metrics, so it's sufficient to query one endpoint
1414
PROXY_DEBUG_ADDR: 0.0.0.0:9205
1515

1616
networks:
1717
ocis-net:
18-
external: true

deployments/examples/ocis_keycloak/.env

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,8 @@ KEYCLOAK_REALM=
3333
KEYCLOAK_ADMIN_USER=
3434
# Admin user login password. Defaults to "admin"
3535
KEYCLOAK_ADMIN_PASSWORD=
36+
# Enable tracing in Keycloak. Traces will be sent to "http://jaeger:4317" Defaults to "false"
37+
KEYCLOAK_TRACING=
3638

3739

3840
# If you want to use debugging and tracing with this stack,

deployments/examples/ocis_keycloak/config/keycloak/docker-entrypoint-override.sh

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
printenv
33
# replace oCIS domain in keycloak realm import
44
mkdir /opt/keycloak/data/import
5-
sed -e "s/ocis.owncloud.test/${OCIS_DOMAIN}/g" /opt/keycloak/data/import-dist/ocis-realm.json > /opt/keycloak/data/import/ocis-realm.json
5+
sed -e "s/ocis.owncloud.test/${OCIS_DOMAIN}/g" /opt/keycloak/data/import-dist/ocis-realm.json > /opt/keycloak/data/import/oCIS-realm.json
66

77
# run original docker-entrypoint
88
/opt/keycloak/bin/kc.sh "$@"

deployments/examples/ocis_keycloak/docker-compose.yml

Lines changed: 11 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -112,10 +112,10 @@ services:
112112
restart: always
113113

114114
keycloak:
115-
image: quay.io/keycloak/keycloak:25.0.0
115+
image: quay.io/keycloak/keycloak:26.2.5
116116
networks:
117117
ocis-net:
118-
command: ["start", "--proxy=edge", "--spi-connections-http-client-default-disable-trust-manager=${INSECURE:-false}", "--import-realm"]
118+
command: ["start", "--spi-connections-http-client-default-disable-trust-manager=${INSECURE:-false}", "--import-realm"]
119119
entrypoint: ["/bin/sh", "/opt/keycloak/bin/docker-entrypoint-override.sh"]
120120
volumes:
121121
- "./config/keycloak/docker-entrypoint-override.sh:/opt/keycloak/bin/docker-entrypoint-override.sh"
@@ -127,9 +127,15 @@ services:
127127
KC_DB_URL: "jdbc:postgresql://postgres:5432/keycloak"
128128
KC_DB_USERNAME: keycloak
129129
KC_DB_PASSWORD: keycloak
130-
KC_FEATURES: impersonation
131-
KEYCLOAK_ADMIN: ${KEYCLOAK_ADMIN_USER:-admin}
132-
KEYCLOAK_ADMIN_PASSWORD: ${KEYCLOAK_ADMIN_PASSWORD:-admin}
130+
KC_FEATURES: impersonation,opentelemetry
131+
KC_BOOTSTRAP_ADMIN_USERNAME: ${KEYCLOAK_ADMIN_USER:-admin}
132+
KC_BOOTSTRAP_ADMIN_PASSWORD: ${KEYCLOAK_ADMIN_PASSWORD:-admin}
133+
# as replacement of --proxy=edge
134+
KC_PROXY_HEADERS: xforwarded
135+
KC_HTTP_ENABLED: true
136+
# tracing
137+
KC_TRACING_ENABLED: ${KEYCLOAK_TRACING:-false}
138+
KC_TRACING_ENDPOINT: http://jaeger:4317
133139
labels:
134140
- "traefik.enable=true"
135141
- "traefik.http.routers.keycloak.entrypoints=https"

deployments/examples/ocis_keycloak/monitoring_tracing/docker-compose-additions.yml

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,13 +6,12 @@ services:
66
environment:
77
# tracing
88
OCIS_TRACING_ENABLED: "true"
9-
OCIS_TRACING_TYPE: "jaeger"
10-
OCIS_TRACING_ENDPOINT: jaeger-agent:6831
9+
OCIS_TRACING_TYPE: "otlp"
10+
OCIS_TRACING_ENDPOINT: jaeger:4317
1111
# metrics
1212
# if oCIS runs as a single process, all <debug>/metrics endpoints
1313
# will expose the same metrics, so it's sufficient to query one endpoint
1414
PROXY_DEBUG_ADDR: 0.0.0.0:9205
1515

1616
networks:
1717
ocis-net:
18-
external: true

deployments/examples/ocis_ldap/monitoring_tracing/docker-compose-additions.yml

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,13 +6,12 @@ services:
66
environment:
77
# tracing
88
OCIS_TRACING_ENABLED: "true"
9-
OCIS_TRACING_TYPE: "jaeger"
10-
OCIS_TRACING_ENDPOINT: jaeger-agent:6831
9+
OCIS_TRACING_TYPE: "otlp"
10+
OCIS_TRACING_ENDPOINT: jaeger:4317
1111
# metrics
1212
# if oCIS runs as a single process, all <debug>/metrics endpoints
1313
# will expose the same metrics, so it's sufficient to query one endpoint
1414
PROXY_DEBUG_ADDR: 0.0.0.0:9205
1515

1616
networks:
1717
ocis-net:
18-
external: true

0 commit comments

Comments
 (0)