Opik (opik)
Observabilité et évaluation open source des LLM : traces, jeux de données, expériences et règles de notation en ligne.
Généré depuis catalog/services/opik.yaml : ne pas modifier à la main.
Résumé
| Version | 1.8.16 |
| Usage | installer et configurer, configurer et connecter |
| Couche | fonctionnelle (catalogue IA) |
| Catégorie | Évaluation et exploitation des LLM |
| Méthodes d'installation | podman |
| Connexion externe | non |
| Réservé au bac à sable | non |
Licence
| Identifiant SPDX | Apache-2.0 |
| Politique de licence | licence socle (MIT ou Apache-2.0) |
| Exception de licence | - |
| Composant de la plateforme | opik |
Paquets et artefacts
Un paquet que publie le projet du service (son image, son archive binaire, son paquet Python ou système) porte la licence du service ; un paquet tiers porte la licence écrite sur sa ligne, lue dans les métadonnées officielles du projet amont.
| Type | Paquet | Version | Licence | Détails |
|---|---|---|---|---|
| image de conteneur | ghcr.io/comet-ml/opik/opik-backend | 1.8.16 | Apache-2.0 | clé d'image backend, utilisée par backend, condensé sha256:3235c026ff3d3c79c14a4019d7cb5939d5c656ce339c1e3d8ad871acefc87d1d |
| image de conteneur | ghcr.io/comet-ml/opik/opik-python-backend | 1.8.16 | Apache-2.0 | clé d'image python-backend, utilisée par python-backend, condensé sha256:dece136e60eb8c6005182753e0f5ae927b865188d006599ccbdb09be2d7e5c87 |
| image de conteneur | ghcr.io/comet-ml/opik/opik-frontend | 1.8.16 | Apache-2.0 | clé d'image frontend, utilisée par frontend, condensé sha256:eefeef6e4fca4ede768b01aa5e104ca762bd89ea249b2d37708d08072503acba |
Les images sont épinglées par étiquette dans le descripteur, et par condensé (digest) quand le descripteur en déclare un (le bundle hors ligne refuse alors une image téléchargée qui ne le porte pas) ; le condensé est enregistré dans le miroir du Manager à l'import du bundle hors ligne, et chaque téléchargement ou chargement est vérifié par rapport à lui.
Systèmes et architectures pris en charge
| Méthode | Systèmes d'exploitation | Architectures |
|---|---|---|
podman | famille RHEL (dnf), famille Debian (apt), Arch Linux (pacman) | x86_64, aarch64 (non restreintes par le descripteur) |
Systèmes hôtes certifiés : RHEL 8/9/10, Rocky Linux 8/9/10, AlmaLinux 8/9/10, Oracle Linux 8/9, CentOS Stream 9/10, Ubuntu 22.04/24.04, Debian 12, Arch Linux (rolling). Le contrôle préalable des hôtes accepte ces systèmes (une autre version d'une famille connue donne un avertissement, une version en fin de vie est refusée) et les architectures x86_64 et aarch64.
Prérequis
Hôte
- au moins 4096 Mo de mémoire (avertissement,
memory).
Réseau et ports
| Composant | Nom du port | Port | Ouvert dans le pare-feu de l'hôte |
|---|---|---|---|
python-backend | http | 8000/tcp | non |
backend | api | 8080/tcp | oui |
backend | admin | 3003/tcp | non |
frontend | ui | 5180/tcp | oui |
Services et connexions nécessaires
mysql:mysql.clickhouse:clickhouse.redis:redis.s3:seaweedfs.
Détail et résolution : voir Dépendances.
Méthodes et modes d'installation
| Méthode | Défaut | Ce que la méthode utilise |
|---|---|---|
podman | oui | les images de conteneur du descripteur, exécutées par Podman sous systemd |
Composants
| Composant | Type | Méthodes d'installation | Ports |
|---|---|---|---|
Backend Python (python-backend) | maître | podman | 8000/tcp |
Backend (backend) | maître | podman | 8080/tcp, 3003/tcp |
Interface (frontend) | maître | podman | 5180/tcp |
backendne tourne que sur un hôte qui porte aussipython-backend.frontendne tourne que sur un hôte qui porte aussibackend(modesingle).
Unique (single) (par défaut)
Une instance de chaque composant.
Ce que le mode déploie :
| Composant | Placement |
|---|---|
python-backend | min 1, max 1 |
backend | min 1, max 1 |
frontend | min 1, max 1 |
Répliqué (replicated)
Plusieurs instances sans état derrière le répartiteur de charge, avec la base d'état MySQL, ClickHouse, Redis et le compartiment des pièces jointes des liaisons partagés ; placer un backend Python sur chaque hôte de backend, chaque interface répartit sur tous les backends.
Ce que le mode déploie :
| Composant | Placement |
|---|---|
python-backend | min 2, recommandé 2 |
backend | min 2, recommandé 2 |
frontend | min 1, recommandé 2 |
Installer ce service
L'assistant d'installation du Navin Manager planifie, valide et exécute l'installation ; il faut la permission services:install sur le cluster.
-
Ouvrez l'assistant. Dans Clusters, choisissez l'action de ligne Installer des services du cluster cible. L'assistant s'ouvre sur sa première étape, Service.
-
Choisissez le service. À l'étape Service, sélectionnez Opik. La carte affiche la licence
Apache-2.0et les dépendances dont l'installation a besoin. -
Choisissez les hôtes et le mode. À l'étape Hôtes, cochez les hôtes, puis choisissez le Mode :
single(par défaut),replicated. Chaque mode déploie les composants listés dans Méthodes et modes d'installation. Avec plusieurs composants, placez chacun sur ses hôtes dans Répartition des composants (Proposer un placement propose un placement qui respecte les cardinalités). -
Liez les dépendances. À l'étape Liaisons, choisissez pour chaque dépendance (
mysql,clickhouse,redis,s3) Installer avec la plateforme ou Utiliser une connexion existante ; une dépendance facultative peut rester sur Aucune liaison. -
Configurez. À l'étape Configuration, relisez les paramètres (voir Paramètres de configuration). Les mots de passe laissés vides avec une valeur générée par défaut sont générés et scellés par le Manager.
-
Relisez et installez. À l'étape Installation, le Manager valide le plan et affiche l'ordre d'installation ; quand il indique « Le plan est valide. Prêt pour l'installation. », choisissez Installer. Un mode hautement disponible n'est installé que si ses contrôles HA réussissent.
-
Vérifiez. L'opération se termine quand les contrôles de santé de chaque instance réussissent (voir Contrôles de santé) ; le service apparaît alors en marche dans Services.
Connecter un service existant
| Schémas | https, http |
| Port par défaut | 8080 |
| Authentification | facultative |
| Contrôle de santé | health_url + /health-check |
| Méthode d'authentification | Champs | Description |
|---|---|---|
none | - | Opik open source auto-hébergé : pas d'authentification. |
api_key | api_key | Opik Cloud ou Enterprise : clé d'API, envoyée sans Bearer, avec l'espace de travail du champ Espace de travail. |
Documentation officielle : https://www.comet.com/docs/opik/reference/rest_api/opik-rest-api/
| Champ | Type | Défaut | Description | Remarques |
|---|---|---|---|---|
URL du point de santé (health_url) | url | - | URL du point de santé du service existant. | - |
Espace de travail (workspace) | string | default | Espace de travail utilisé par la plateforme. | - |
Haute disponibilité
| Cluster | réplicas (replication) |
| Haute disponibilité | externe (external) |
| Bascule | répartiteur (load-balancer) |
| Réplication | stockage partagé (shared-store) |
| Quorum | aucun (none) |
| Découverte | aucun (none) |
| Point d'entrée | répartiteur (load-balancer) |
| Documentation officielle | https://www.comet.com/docs/opik/self-host/scaling |
Prérequis
| Prérequis | Doit être hautement disponible | Modes | Description |
|---|---|---|---|
mysql | oui | modes de niveau ha ou cluster | MySQL hautement disponible (base d'état). |
clickhouse | oui | modes de niveau ha ou cluster | ClickHouse hautement disponible (traces et spans). |
redis | oui | modes de niveau ha ou cluster | Redis hautement disponible. |
s3 | oui | modes de niveau ha ou cluster | Stockage objet hautement disponible pour les pièces jointes. |
Topologie par mode
| Modes | Niveau le plus haut du catalogue | Répartition | Composant du quorum | Domaines de panne | Description |
|---|---|---|---|---|---|
single | autonome (standalone) | unique (single) | - | 1 | Une instance de chaque composant. |
replicated | ha (ha) | actif-actif (active-active) | - | 2 | Plusieurs backends, backends Python et frontends sans état partageant MySQL, ClickHouse, Redis et le bucket. |
Paramètres de configuration
Général
| Paramètre | Type | Défaut | Valeurs permises | Obligatoire | Secret | Redémarrage | Description |
|---|---|---|---|---|---|---|---|
Port du backend (backend_port) | port | 8080 | - | non | non | non | Port de l'API REST et OTLP. |
Port d'administration du backend (backend_admin_port) | port | 3003 | - | non | non | non | Port des points de santé et de métriques du backend. |
Port du backend Python (python_backend_port) | port | 8000 | - | non | non | non | Port de l'évaluateur Python. |
Port de l'interface (frontend_port) | port | 5180 | - | non | non | non | Port de l'interface web (nginx). |
TLS (tls_enabled) | bool | false | - | non | non | oui | Servir l'interface web et son entrée /api/ (API REST et OTLP du SDK à travers l'interface) en HTTPS avec un certificat de l'autorité du Manager (nginx de l'image, TLS 1.2 et 1.3). Le port du backend reste lui en HTTP : diriger le SDK et les exportateurs OTLP vers https://<interface>/api. |
Dépendances
Pour chaque dépendance active, le Manager prend la première solution parmi : la liaison choisie dans l'assistant ; un service de la même installation qui la fournit ; un service déjà installé dans le cluster ; la seule connexion du type attendu. Sinon, une dépendance facultative reste non liée, et une dépendance obligatoire est ajoutée à l'installation dans son mode par défaut (la colonne ci-dessous nomme le service du catalogue ajouté).
| Liaison | Fournie par | Type de connexion | Point d'accès | Facultative | Quand rien n'est lié | Description |
|---|---|---|---|---|---|---|
mysql | - | mysql | - | non | mysql est ajouté à l'installation | Base d'état : MySQL 8.4 (GPL-2.0) fournie par le client ou installée séparément, jamais livrée avec Opik. |
clickhouse | - | clickhouse | - | non | clickhouse est ajouté à l'installation | Stockage analytique des traces et intervalles. |
redis | - | redis | - | non | redis est ajouté à l'installation | Cache et verrous. |
s3 | seaweedfs | s3 | s3 | non | seaweedfs est ajouté à l'installation | Compartiment des pièces jointes (SeaweedFS de la plateforme par défaut, ou une connexion S3 existante). |
Points d'accès
| Point d'accès | Schéma | Composant | Port | Chemin | Paramètre TLS | Paramètres de liaison | Secrets de liaison | Commande de provisionnement |
|---|---|---|---|---|---|---|---|---|
api | http | backend | 8080 (backend_port) | - | - | - | - | - |
ui | http | frontend | 5180 (frontend_port) | - | tls_enabled | - | - | - |
Contrôles de santé
Vivacité (par instance)
| Composant | Contrôle | Détails |
|---|---|---|
python-backend | HTTP http://127.0.0.1:{{ config.python_backend_port }}/healthcheck | Attendu 200 ; 60 tentatives ; intervalle 3 s ; délai 5 s |
backend | HTTP http://127.0.0.1:{{ config.backend_admin_port }}/health-check | Attendu 200 ; 90 tentatives ; intervalle 3 s ; délai 5 s |
frontend | HTTP {{ 'https' if config.tls_enabled else 'http' }}://{{ host.ip or '127.0.0.1' }}:{{ config.frontend_port }}/ | Attendu 200 ; 30 tentatives ; intervalle 2 s ; délai 5 s |
Contrôles préalables
| Contrôle | Type | Signification | Sévérité | Composants |
|---|---|---|---|---|
memory | memory_mb {"min": 4096} | au moins 4096 Mo de mémoire | avertissement | tous les composants |
Désinstallation
Chemins supprimés quand les données sont purgées : {{ paths.data }}, {{ paths.log }}.
Liens rapides
- Opik :
{{ 'https' if config.tls_enabled else 'http' }}://{{ host.fqdn }}:{{ config.frontend_port }}/
Documentation amont
- Site : https://www.comet.com/site/products/opik/
- Sources : https://github.com/comet-ml/opik
- Haute disponibilité : https://www.comet.com/docs/opik/self-host/scaling
- Authentification : https://www.comet.com/docs/opik/reference/rest_api/opik-rest-api/