> ## 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.

# Supervisión y administración

> Supervise y administre ABBYY Vantage autoalojado: archivos de log, el servicio integrado Skill Monitor, herramientas de terceros y recopilación de datos para soporte técnico.

Como administrador del sistema, su tarea es supervisar ABBYY Vantage en todo momento, administrarlo y detectar cualquier error que pueda producirse durante el procesamiento de documentos, así como las causas de esos errores.

Puede supervisar ABBYY Vantage mediante lo siguiente:

* **Archivos de log de Vantage**
* **El servicio integrado Skill Monitor**, que recopila estadísticas de las skills existentes de Vantage y proporciona información detallada sobre las transacciones completadas y en curso. Este servicio también le permite obtener la información sobre eventos de transacción necesaria para el soporte técnico.
* **Servicios de terceros** que le permiten supervisar los procesos internos de Vantage, supervisar flujos de trabajo específicos, analizar los datos recopilados para seguir ajustando y optimizando el procesamiento de documentos, y recopilar y analizar logs.

Al ponerse en contacto con el soporte técnico, además de la información sobre los errores, también puede proporcionar la versión del producto y sus componentes de la siguiente manera:

1. Haga clic en **Ayuda** en el panel izquierdo, luego en **Acerca de** y seleccione **Version details**.
2. Copie los detalles.

<div id="how-to-access-diagnostics-logs">
  ## Cómo acceder a los logs de diagnóstico
</div>

Los archivos de log creados durante el procesamiento de documentos en Vantage se almacenan localmente en las máquinas utilizadas para la instalación del producto.

Los logs se almacenan de la siguiente manera: el agente de Fluent Bit que se ejecuta en todos los nodos de Kubernetes recopila los logs de los contenedores y los envía al servicio agregador Fluentd. De forma predeterminada, todos los logs se almacenan como archivos archivados en un volumen persistente y se puede acceder a ellos mediante NFS. De forma opcional, el administrador también puede enviar los logs al clúster de Elasticsearch.

<img src="https://mintlify.s3.us-west-1.amazonaws.com/abbyy/images/vantage/self-hosted/misc-p01-045.png" alt="Arquitectura de logging de Kubernetes que muestra agentes de Fluent Bit recopilando logs de contenedores Docker y enviándolos al agregador Fluentd, que envía la salida a Elasticsearch y al almacenamiento en volumen persistente" style={{ width:"62%" }} />

Para acceder a los logs de diagnóstico:

1. Si está utilizando un servidor NFS externo u otro almacenamiento externo, vaya directamente al paso 3.
2. Para una instalación con un servidor NFS dentro del clúster (predeterminado para la configuración **Without high availability**), obtenga la dirección IP del servidor NFS:

```bash theme={null}
kubectl -n nfs get po -lapp.kubernetes.io/name=nfs-kernel-server -o jsonpath='{ .items[*].status.hostIP }'
```

3. Acceda al recurso compartido:
   * **Para NFS:**
     * Linux: `mount –t nfs <nfs server ip>:/ /opt/mount`
     * Windows: Instale ClientForNFS, abra el Explorador de archivos y vaya a `\\<nfs server ip>`
   * **Para otros tipos de almacenamiento externo:** Póngase en contacto con el Administrador del sistema para obtener instrucciones de acceso.
4. Vaya al directorio `\\<nfs server ip>\<sharename>\<env>\abbyy-monitoring\fluentd-pvc`.

<div id="providing-logs-to-technical-support">
  ### Proporcionar logs al soporte técnico
</div>

Para proporcionar a ABBYY technical support los logs de Vantage:

1. Vaya a la carpeta de logs. Los logs se almacenan en subcarpetas que tienen los mismos nombres que los namespaces del clúster de Kubernetes. Los logs de Vantage se encuentran en la carpeta `abbyy-vantage`.
2. Copie los archivos correspondientes al período en el que se produjo el problema. Los logs se comprimen en archivos gzip con nombres en el formato `Y-M-DD-H` (por ejemplo, `2022-12-09-0800.log.gz`).
3. Envíe los archivos a ABBYY technical support.

<div id="elasticsearch-and-kibana">
  ## Elasticsearch and Kibana
</div>

Elasticsearch y Kibana son herramientas para buscar, analizar y visualizar logs. Elasticsearch y Kibana no se instalan junto con ABBYY Vantage y deben instalarse y configurarse por separado. Esto puede hacerse tanto si el producto está instalado como si no. Puede usar cualquier instalación existente.

<Note>
  El procedimiento de configuración de ejemplo que aparece a continuación se ha simplificado y se proporciona únicamente a modo de ejemplo.
</Note>

Para instalar Elasticsearch y Kibana:

1. Clone el repositorio:

```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. Instala el operador que despliega los recursos:

```bash theme={null}
helm -n elastic upgrade -i eck-operator . --create-namespace
```

3. Crea un archivo llamado `elastic.yaml` con el siguiente contenido:

```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. Cree un archivo llamado `kibana.yaml` con el siguiente contenido:

```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. Ejecute el siguiente comando para instalar Elasticsearch:

```bash theme={null}
kubectl -n elastic apply -f elastic.yaml
```

Verifica el estado del despliegue:

```bash theme={null}
kubectl -n elastic get statefulset
```

6. Ejecute el siguiente comando para instalar Kibana:

```bash theme={null}
kubectl -n elastic apply -f kibana.yaml
```

Compruebe el estado del despliegue:

```bash theme={null}
kubectl -n elastic get deployment
```

7. Obtén la contraseña de un usuario de Elasticsearch:

```bash theme={null}
kubectl -n elastic get secret elasticsearch-es-elastic-user -o go-template='{{.data.elastic | base64decode }}'
```

8. Agrega los siguientes parámetros a tu archivo `env_specific.yaml`:

```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. Si va a instalar Kibana después de haber instalado ya el producto, actualice su archivo `env_specific.yaml` y ejecute el siguiente comando:

```bash theme={null}
ansible-playbook -i inventories/k8s playbooks/6-DeployMonitoring-k8s.yml
```

<div id="grafana">
  ## Grafana
</div>

Grafana (utilizado junto con Prometheus) es una herramienta para visualizar, monitorizar y analizar datos. Grafana no se instala junto con ABBYY Vantage y debe instalarse y configurarse por separado. Puede usar cualquier instalación existente.

<Note>
  Grafana debe instalarse en el clúster, ya que Prometheus solo está disponible dentro de un clúster.
</Note>

<Note>
  El procedimiento de configuración de ejemplo que se muestra a continuación se ha simplificado y se proporciona únicamente a modo de ejemplo.
</Note>

Para instalar Grafana:

1. Cree un archivo llamado `grafana.yaml`.
2. Copie y pegue el siguiente código en el archivo y guárdelo:

```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'
```

<Note>
  Reemplaza el valor del parámetro host por el nombre de dominio de tu clúster de Vantage y cambia la contraseña inicial del administrador.
</Note>

3. Ejecuta los siguientes comandos:

```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
```
