Toggle LangSmith telemetry through the helm chart

charts/langsmith/README.md

@@ -1,6 +1,6 @@
 # langsmith
 
-![Version: 0.10.28](https://img.shields.io/badge/Version-0.10.28-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square) ![AppVersion: 0.10.74](https://img.shields.io/badge/AppVersion-0.10.74-informational?style=flat-square)
+![Version: 0.10.29](https://img.shields.io/badge/Version-0.10.29-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square) ![AppVersion: 0.10.74](https://img.shields.io/badge/AppVersion-0.10.74-informational?style=flat-square)
 
 Helm chart to deploy the langsmith application and all services it depends on.
 
@@ -233,6 +233,11 @@ For information on how to use this chart, up-to-date release notes, and other gu
 | config.oauth.oauthIssuerUrl | string | `""` |  |
 | config.oauth.oauthScopes | string | `"email,profile,openid"` |  |
 | config.oauth.oauthSessionMaxSec | string | `"86400"` |  |
+| config.observability.tracing.enabled | bool | `false` |  |
+| config.observability.tracing.endpoint | string | `""` |  |
+| config.observability.tracing.env | string | `"ls_self_hosted"` |  |
+| config.observability.tracing.exporter | string | `"http"` |  |
+| config.observability.tracing.useTls | bool | `true` |  |
 | config.orgCreationDisabled | bool | `false` | Prevent organization creation. If using basic auth, this is set to true by default. |
 | config.personalOrgsDisabled | bool | `false` | Disable personal orgs. Users will need to be invited to an org manually. If using basic auth, this is set to true by default. |
 | config.settings | object | `{"redisRunsExpirySeconds":"21600"}` | Application Settings. These are used to tune the application |
@@ -485,6 +490,8 @@ For information on how to use this chart, up-to-date release notes, and other gu
 | clickhouse.external.tlsSecretKey | string | `"clickhouse_tls"` |  |
 | clickhouse.external.user | string | `"default"` |  |
 | clickhouse.external.userSecretKey | string | `"clickhouse_user"` |  |
+| clickhouse.metrics.enabled | bool | `true` |  |
+| clickhouse.metrics.port | int | `9363` |  |
 | clickhouse.name | string | `"clickhouse"` |  |
 | clickhouse.pdb.annotations | object | `{}` |  |
 | clickhouse.pdb.enabled | bool | `false` |  |

charts/langsmith/ci/telemetry-config-values.yaml

@@ -0,0 +1,89 @@
+# Lightweight configuration with telemetry enabled. Only use this if you are running Langsmith in a development environment.
+config:
+  langsmithLicenseKey: "YOUR_LICENSE_KEY"
+  apiKeySalt: "YOUR_API_KEY_SALT"
+  authType: "mixed"
+  basicAuth:
+    enabled: true
+    initialOrgAdminEmail: "[email protected]"
+    initialOrgAdminPassword: "TestLangSmith123!"
+    jwtSecret: "YOUR_JWT_SECRET"
+
+  observability:
+    tracing:
+      enabled: true
+      endpoint: "YOUR_COLLECTOR_ENDPOINT"
+      env: "ls_self_hosted"
+      exporter: "http"
+      useTls: true
+
+# Note, you likely should tweak the values to match something that fits your local development environment.
+aceBackend:
+  deployment:
+    resources:
+      requests:
+        cpu: 100m
+        memory: 500Mi
+
+backend:
+  deployment:
+    resources:
+      requests:
+        cpu: 100m
+        memory: 500Mi
+
+frontend:
+  deployment:
+    resources:
+      requests:
+        cpu: 100m
+        memory: 500Mi
+
+platformBackend:
+  deployment:
+    resources:
+      requests:
+        cpu: 100m
+        memory: 500Mi
+
+playground:
+  deployment:
+    resources:
+      requests:
+        cpu: 100m
+        memory: 500Mi
+
+queue:
+  replicas: 1
+  deployment:
+    resources:
+      requests:
+        cpu: 100m
+        memory: 500Mi
+
+postgres:
+  metrics:
+    enabled: true
+  statefulSet:
+    resources:
+      requests:
+        cpu: 200m
+        memory: 500Mi
+
+redis:
+  metrics:
+    enabled: true
+  statefulSet:
+    resources:
+      requests:
+        cpu: 200m
+        memory: 500Mi
+
+clickhouse:
+  metrics:
+    enabled: true
+  statefulSet:
+    resources:
+      requests:
+        cpu: 200m
+        memory: 500Mi

charts/langsmith/templates/clickhouse/config-map.yaml

@@ -35,7 +35,7 @@ data:
         </profiles>
     </clickhouse>
 
-  config.xml: |
+  logging_config.xml: |
     <clickhouse>
         <logger>
           <level>{{ .Values.clickhouse.config.logLevel }}</level>
@@ -52,4 +52,18 @@ data:
           <count>10</count>
       </logger>
     </clickhouse>
+
+  {{- if .Values.clickhouse.metrics.enabled }}
+  metrics_config.xml: |
+    <clickhouse>
+      <prometheus>
+        <endpoint>/metrics</endpoint>
+        <port>{{ .Values.clickhouse.metrics.port }}</port>
+        <metrics>true</metrics>
+        <events>true</events>
+        <asynchronous_metrics>true</asynchronous_metrics>
+        <errors>true</errors>
+      </prometheus>
+    </clickhouse>
+  {{- end }}
 {{- end }}

charts/langsmith/templates/clickhouse/service.yaml

@@ -29,6 +29,12 @@ spec:
       port: {{ .Values.clickhouse.service.nativePort }}
       targetPort: ch-native
       protocol: TCP
+    {{- if .Values.clickhouse.metrics.enabled }}
+    - name: ch-metrics
+      port: {{ .Values.clickhouse.metrics.port }}
+      targetPort: {{ .Values.clickhouse.metrics.port }}
+      protocol: TCP
+    {{- end }}
   selector:
     {{- include "langsmith.selectorLabels" . | nindent 4 }}
     app.kubernetes.io/component: {{ include "langsmith.fullname" . }}-{{ .Values.clickhouse.name }}

charts/langsmith/templates/clickhouse/stateful-set.yaml

@@ -83,6 +83,11 @@ spec:
             - name: ch-native
               containerPort: {{ .Values.clickhouse.containerNativePort }}
               protocol: TCP
+            {{- if .Values.clickhouse.metrics.enabled }}
+            - name: ch-metrics
+              containerPort: {{ .Values.clickhouse.metrics.port }}
+              protocol: TCP
+            {{- end }}
           {{- with .Values.clickhouse.statefulSet.startupProbe }}
           startupProbe:
             {{- toYaml . | nindent 12 }}
@@ -110,9 +115,14 @@ spec:
             - mountPath: /etc/clickhouse-server/users.d/users.xml
               name: clickhouse-conf
               subPath: users.xml
-            - mountPath: /etc/clickhouse-server/config.d/config.xml
+            - mountPath: /etc/clickhouse-server/config.d/logging_config.xml
               name: clickhouse-conf
-              subPath: config.xml
+              subPath: logging_config.xml
+            {{- if .Values.clickhouse.metrics.enabled }}
+            - mountPath: /etc/clickhouse-server/config.d/metrics_config.xml
+              name: clickhouse-conf
+              subPath: metrics_config.xml
+            {{- end }}
           {{- with .Values.clickhouse.statefulSet.extraContainerConfig }}
             {{- toYaml . | nindent 10 }}
           {{- end }}
@@ -142,8 +152,12 @@ spec:
             items:
               - key: users.xml
                 path: users.xml
-              - key: config.xml
-                path: config.xml
+              - key: logging_config.xml
+                path: logging_config.xml
+              {{- if .Values.clickhouse.metrics.enabled }}
+              - key: metrics_config.xml
+                path: metrics_config.xml
+              {{- end }}
       {{- with .Values.clickhouse.statefulSet.volumes }}
           {{- toYaml . | nindent 8 }}
       {{- end }}

charts/langsmith/templates/config-map.yaml

@@ -33,3 +33,10 @@ data:
   SMITH_BACKEND_ENDPOINT: "http://{{ include "langsmith.fullname" . }}-{{.Values.backend.name}}.{{ .Release.Namespace }}.svc.cluster.local:{{ .Values.backend.service.port }}"
   HOST_BACKEND_ENDPOINT: "http://{{ include "langsmith.fullname" . }}-{{.Values.hostBackend.name}}.{{ .Release.Namespace }}.svc.cluster.local:{{ .Values.hostBackend.service.port }}"
   FF_RUN_STATS_GROUP_BY_ENABLED_ALL: "true"
+  {{- if .Values.config.observability.tracing.enabled }}
+  OTEL_TRACING_ENABLED: {{ .Values.config.observability.tracing.enabled }}
+  OTLP_ENDPOINT: "http://{{ .Values.config.observability.tracing.endpoint }}"
+  OTEL_ENVIRONMENT: "{{ .Values.config.observability.tracing.env }}"
+  OTEL_EXPORTER: "{{ .Values.config.observability.tracing.exporter }}"
+  OTLE_USE_TLS: {{ .Values.config.observability.tracing.useTls }}
+  {{- end }}

charts/langsmith/values.yaml

@@ -171,6 +171,14 @@ config:
     logoUrl: ""
     coBrandingEnabled: true
 
+  observability:
+    tracing:
+      enabled: false
+      endpoint: ""
+      useTls: true
+      env: "ls_self_hosted"
+      exporter: "http"
+
 aceBackend:
   name: "ace-backend"
   containerPort: 1987
@@ -546,6 +554,9 @@ clickhouse:
     name: ""
     labels: {}
     annotations: {}
+  metrics:
+    enabled: true
+    port: 9363
 
 e2eTest:
   name: "e2e-test"