> ## Documentation Index
> Fetch the complete documentation index at: https://docs.abbyy.com/llms.txt
> Use this file to discover all available pages before exploring further.
# Überwachung und Administration
> Überwachen und verwalten Sie ABBYY Vantage Self-Hosted: Protokolldateien, den integrierten Service Skill Monitor, Tools von Drittanbietern und das Erfassen von Daten für den technischen Support.
Als Systemadministrator sind Sie dafür verantwortlich, ABBYY Vantage jederzeit zu überwachen, zu verwalten sowie alle Fehler, die bei der Dokumentverarbeitung auftreten können, und deren Ursachen zu erkennen.
Sie können ABBYY Vantage mit folgenden Mitteln überwachen:
* **Vantage-Protokolldateien**
* **Dem integrierten Service Skill Monitor**, der Statistiken zu vorhandenen Vantage-Skills erfasst und detaillierte Informationen zu abgeschlossenen und laufenden Vorgängen bereitstellt. Mit diesem Service können Sie außerdem die vom technischen Support benötigten Informationen zu Ereignissen in Vorgängen abrufen.
* **Services von Drittanbietern**, mit denen Sie interne Vantage-Prozesse und bestimmte Workflows überwachen, erfasste Daten analysieren, um die Dokumentverarbeitung weiter zu optimieren, sowie Protokolle erfassen und auswerten können.
Wenn Sie den technischen Support kontaktieren, können Sie zusätzlich zu Informationen über Fehler auch die Version des Produkts und seiner Komponenten angeben, indem Sie Folgendes tun:
1. Klicken Sie im linken Bereich auf **Help**, dann auf **About**, und wählen Sie **Version details** aus.
2. Kopieren Sie die Details.
## So greifen Sie auf Diagnoseprotokolle zu
Die Protokolldateien, die bei der Verarbeitung von Dokumenten in Vantage erstellt werden, werden lokal auf den für die Produktinstallation verwendeten Rechnern gespeichert.
Die Protokolle werden wie folgt gespeichert: Der Fluent-Bit-Agent, der auf allen Kubernetes-Knoten ausgeführt wird, erfasst Container-Protokolle und sendet sie an den Fluentd-Aggregator-Service. Standardmäßig werden alle Protokolle als Archivdateien auf einem persistenten Volume gespeichert und können über NFS abgerufen werden. Optional kann der Administrator die Protokolle auch an den Elasticsearch-Cluster senden.
So greifen Sie auf Diagnoseprotokolle zu:
1. Wenn Sie einen externen NFS-Server oder einen anderen externen Speicher verwenden, fahren Sie direkt mit Schritt 3 fort.
2. Ermitteln Sie bei einer Installation mit einem In-Cluster-NFS-Server (Standard für die Konfiguration **Ohne Hochverfügbarkeit**) die IP-Adresse des NFS-Servers:
```bash theme={null}
kubectl -n nfs get po -lapp.kubernetes.io/name=nfs-kernel-server -o jsonpath='{ .items[*].status.hostIP }'
```
3. Greifen Sie auf die Freigabe zu:
* **Für NFS:**
* Linux: `mount –t nfs :/ /opt/mount`
* Windows: Installieren Sie ClientForNFS, öffnen Sie den Explorer und wechseln Sie zu `\\`
* **Für andere Arten von externem Speicher:** Wenden Sie sich an Ihren Systemadministrator, um Anweisungen für den Zugriff zu erhalten.
4. Navigieren Sie zum Verzeichnis `\\\\\abbyy-monitoring\fluentd-pvc`.
### Protokolle für den technischen Support bereitstellen
So stellen Sie dem ABBYY-Kundensupport Vantage-Protokolle zur Verfügung:
1. Navigieren Sie zum Ordner mit den Protokollen. Die Protokolle werden in Unterordnern gespeichert, die dieselben Namen wie die Namespaces des Kubernetes-Clusters haben. Die Vantage-Protokolle befinden sich im Ordner `abbyy-vantage`.
2. Kopieren Sie die Dateien aus dem Zeitraum, in dem das Problem aufgetreten ist. Die Protokolle sind als gzip-Dateien komprimiert und haben Namen im Format `Y-M-DD-H` (z. B. `2022-12-09-0800.log.gz`).
3. Senden Sie die Dateien an den technischen Support von ABBYY.
## Elasticsearch und Kibana
Elasticsearch und Kibana sind Tools zum Suchen, Analysieren und Visualisieren von Protokollen. Elasticsearch und Kibana werden nicht zusammen mit ABBYY Vantage installiert und müssen separat installiert und eingerichtet werden. Dies ist unabhängig davon möglich, ob das Produkt installiert ist oder nicht. Sie können eine vorhandene Installation verwenden.
Das unten beschriebene Beispiel für die Einrichtung wurde vereinfacht und dient nur zur Veranschaulichung.
So installieren Sie Elasticsearch und Kibana:
1. Klonen Sie das Repository:
```bash theme={null}
git clone https://github.com/elastic/cloud-on-k8s.git
cd cloud-on-k8s
git checkout 2.5
cd deploy/eck-operator
```
2. Installieren Sie den Operator, der die Ressourcen bereitstellt:
```bash theme={null}
helm -n elastic upgrade -i eck-operator . --create-namespace
```
3. Erstellen Sie eine Datei namens `elastic.yaml` mit folgendem Inhalt:
```yaml theme={null}
apiVersion: elasticsearch.k8s.elastic.co/v1
kind: Elasticsearch
metadata:
name: elasticsearch
namespace: elastic
spec:
version: 8.5.1
nodeSets:
- config:
indices.fielddata.cache.size: 38%
xpack.ml.enabled: false
xpack.security.enabled: true
count: 1
name: default
podTemplate:
spec:
containers:
- name: elasticsearch
resources:
limits:
memory: 1Gi
cpu: '1'
requests:
cpu: '1'
memory: 1Gi
initContainers:
- command:
- sh
- '-c'
- sysctl -w vm.max_map_count=262144
name: sysctl
securityContext:
privileged: true
runAsUser: 0
nodeSelector:
kubernetes.io/os: linux
volumeClaimTemplates:
- metadata:
name: elasticsearch-data
spec:
accessModes:
- ReadWriteOnce
resources:
requests:
storage: 128Gi
```
4. Erstellen Sie eine Datei namens `kibana.yaml` mit folgendem Inhalt:
```yaml theme={null}
apiVersion: kibana.k8s.elastic.co/v1
kind: Kibana
metadata:
name: kibana
namespace: elastic
spec:
version: 8.5.1
count: 1
elasticsearchRef:
name: elasticsearch
podTemplate:
spec:
containers:
- name: kibana
env:
- name: NODE_OPTIONS
value: "--max-old-space-size=2048"
resources:
requests:
memory: 512Mi
cpu: 0.5
limits:
memory: 1Gi
cpu: 1
nodeSelector:
kubernetes.io/os: linux
```
5. Führen Sie folgenden Befehl aus, um Elasticsearch zu installieren:
```bash theme={null}
kubectl -n elastic apply -f elastic.yaml
```
Prüfen Sie den Bereitstellungsstatus:
```bash theme={null}
kubectl -n elastic get statefulset
```
6. Führen Sie den folgenden Befehl aus, um Kibana zu installieren:
```bash theme={null}
kubectl -n elastic apply -f kibana.yaml
```
Prüfen Sie den Bereitstellungsstatus:
```bash theme={null}
kubectl -n elastic get deployment
```
7. Rufen Sie das Kennwort eines Elasticsearch-Benutzers ab:
```bash theme={null}
kubectl -n elastic get secret elasticsearch-es-elastic-user -o go-template='{{.data.elastic | base64decode }}'
```
8. Fügen Sie Ihrer Datei `env_specific.yaml` die folgenden Parameter hinzu:
```yaml theme={null}
logging:
enabled: true
elasticsearch:
enabled: true
host: elasticsearch-es-http.elastic.svc.cluster.local
username: elastic
password: elastic_user_password
scheme: https
```
9. Wenn Sie Kibana erst installieren, nachdem das Produkt bereits installiert wurde, aktualisieren Sie Ihre Datei `env_specific.yaml` und führen Sie den folgenden Befehl aus:
```bash theme={null}
ansible-playbook -i inventories/k8s playbooks/6-DeployMonitoring-k8s.yml
```
## Grafana
Grafana (in Verbindung mit Prometheus) ist ein Tool zur Visualisierung, Überwachung und Analyse von Daten. Grafana wird nicht zusammen mit ABBYY Vantage installiert und muss separat installiert und eingerichtet werden. Sie können jede vorhandene Installation verwenden.
Grafana muss im Cluster installiert werden, da Prometheus nur innerhalb eines Clusters verfügbar ist.
Das unten beschriebene Beispiel für die Einrichtung wurde vereinfacht und dient nur zur Veranschaulichung.
So installieren Sie Grafana:
1. Erstellen Sie eine Datei mit dem Namen `grafana.yaml`.
2. Kopieren Sie den folgenden Code in die Datei, und speichern Sie sie:
```yaml theme={null}
persistence:
enabled: false
rbac:
create: true
namespaced: false
serviceAccount:
create: true
podLabels:
app.kubernetes.io/component: grafana
nodeSelector:
kubernetes.io/os: linux
adminUser: admin
adminPassword: password
plugins:
- grafana-piechart-panel
- flant-statusmap-panel
grafana.ini:
server:
root_url: "%(protocol)s://%(domain)s:%(http_port)s/grafana/"
enable_gzip: "true"
ingress:
enabled: true
annotations:
kubernetes.io/ingress.class: abbyy-nginx
nginx.ingress.kubernetes.io/rewrite-target: /$2
tls:
- secretName: platform-wildcard
hosts:
- {{ env }}.{{ domain }}
hosts:
- {{ env }}.{{ domain }}
path: "/grafana(/|$)(.*)"
sidecar:
dashboards:
enabled: true
label: grafana_dashboard
datasources:
datasources.yaml:
apiVersion: 1
datasources:
- name: Prometheus
editable: true
isDefault: true
jsonData:
timeInterval: 5s
tlsSkipVerify: true
type: prometheus
url: 'http://prometheus-scaling.abbyy-monitoring.svc.cluster.local:9090'
- editable: true
isDefault: true
jsonData:
timeInterval: 5s
tlsSkipVerify: true
name: Victoria
type: prometheus
url: 'http://victoria-metrics-abbyy.abbyy-monitoring.svc.cluster.local:8428'
```
Ersetzen Sie den Wert des Parameters `host` durch den Domänennamen Ihres Vantage-Clusters und ändern Sie das ursprüngliche Administrator-Kennwort.
3. Führen Sie die folgenden Befehle aus:
```bash theme={null}
helm repo add grafana https://grafana.github.io/helm-charts
helm -n abbyy-monitoring upgrade -i grafana grafana/grafana -f grafana.yaml
```