---
# System prepended metadata

title: Implementación de elastic en equip

---

# Implementación de elastic en equip
## Info General
- Para acceder al servicio online ingresar a https://cloud.elastic.co/login con el mail anibal.cerda@equipcollaboration.com y su contraseña.
- Dentro del servicio, ingresar a kibana, que es el servicio que recibe los logs y permite visualizarlos.

## ¿Cómo visualizar los logs en kibana?
- Abrir el menu hamburguesa y hacer click en discover, dentro del servicio kibana.
- Escoger index a visualizar:
    - El indice se escoge en la esquina superior izquierda, hacer click en la pestaña y escoger el indice a visualizar.
    - Hay dos indices utilizados hasta ahora
        - filebeat-*: Considera los logs de las llamadas http de los usuarios
        - metricbeat-*: Considera los logs de las métricas de los servidores.
    - Luego de esocger un índice hay que asegurarse de que escogemos un rango de tiempo donde existan registros, este rango se configura en la esquina derecha.
    - Refresh permite actualizar los logs que todavía no han sido incorporados.
    - Se puede ver el detalle de cada log al hacer click en su pestaña en particular.
    - En el menú de la izquierda se puede escoger los fields que nos interesa observar. En popular están todos los atributos creados para equip:
        - duration: Cuánto demoró el servidor en responder a la llamada http.
        - error: En el caso de las llamadas de la api aparece el error recibido, en el caso de errores del cron aparece el log completo del error, incluído su stack
        - event.action: Nombre de la acción de equip si es que existe
        - http.request.method: Método http utilizado (GET, POST)
        - htto,response.status_code: Código http respondido
        - log.level: El nivel del log (info, warn, error)
        - url.path: La dirección urll que fue consultada
## ¿Cómo agregar una alarma?
- Ir al menú hamburguesa, en la última categoría "Management" hacer click en "Stack Management"
- En el menú de la izquierda hacer click en "Alerts and Actions" dentro de la categoría "Alerts and Insights"
- Hacer click en crear alerta
- Definir los parametros
- Seleccionar trigger type: Log threshold para los relacionados con el log
- Definir "la query" que gatilla la alarma
- Definir actions: email
- Generar un nuevo conector (para no reutilizar mi mail 3s para el envío de alarmas)
- Definir a quién le llegan las alarmas, y el título y contenido del mensaje.

## ¿Cómo incluir un nuevo servidor para monitorear sus logs?
- Hay que instalar 2 servicios de elastic: [filebeat](https://www.elastic.co/guide/en/beats/filebeat/current/index.html) para enviar los requests de los usuarios y errores del cron y [metricbeat](https://www.elastic.co/guide/en/beats/metricbeat/current/index.html) para enviar el uso de recursos del servidor.
### Filebeat
1. Instalar Filebeat a través de APT [Instrucciones](https://www.elastic.co/guide/en/beats/filebeat/current/setup-repositories.html#setup-repositories)
2. Reemplazar el archivo de configuración de filebeat en `/etc/filebeat/filebeat.yml` por el siguiente archivo.

```yml=
###################### Filebeat Configuration Example #########################

# This file is an example configuration file highlighting only the most common
# options. The filebeat.reference.yml file from the same directory contains all the
# supported options with more comments. You can use it as a reference.
#
# You can find the full configuration reference here:
# https://www.elastic.co/guide/en/beats/filebeat/index.html

# For more available modules and options, please see the filebeat.reference.yml sample
# configuration file.

# ============================== Filebeat inputs ===============================

filebeat.inputs:

# Each - is an input. Most options can be set at the input level, so
# you can use different inputs for various configurations.
# Below are the input specific configurations.

- type: log

  # Change to true to enable this input configuration.
  enabled: true

  # Paths that should be crawled and fetched. Glob based paths.
  paths:
    - /home/logs/access*.log.gz
    - /home/logs/cron*.log.gz
    - /home/logs/nextDay*.log.gz
    #- /home/logs/routeHandlersErrors*.log.gz
    #- c:\programdata\elasticsearch\logs\*

  # Exclude lines. A list of regular expressions to match. It drops the lines that are
  # matching any regular expression from the list.
  #exclude_lines: ['^DBG']

  # Include lines. A list of regular expressions to match. It exports the lines that are
  # matching any regular expression from the list.
  #include_lines: ['^ERR', '^WARN']

  # Exclude files. A list of regular expressions to match. Filebeat drops the files that
  # are matching any regular expression from the list. By default, no files are dropped.
  #exclude_files: ['.gz$']

  # Optional additional fields. These fields can be freely picked
  # to add additional information to the crawled log files for filtering
  #fields:
  #  level: debug
  #  review: 1

  ### Multiline options

  # Multiline can be used for log messages spanning multiple lines. This is common
  # for Java Stack Traces or C-Line Continuation

  # The regexp Pattern that has to be matched. The example pattern matches all lines starting with [
  # multiline.pattern: ^\[

  # Defines if the pattern set under pattern should be negated or not. Default is false.
  #multiline.negate: true

  # Match can be set to "after" or "before". It is used to define if lines should be append to a pattern
  # that was (not) matched before or after or as long as a pattern is not matched based on negate.
  # Note: After is the equivalent to previous and before is the equivalent to to next in Logstash
  #multiline.match: after

# filestream is an experimental input. It is going to replace log input in the future.
- type: filestream

  # Change to true to enable this input configuration.
  enabled: false

  # Paths that should be crawled and fetched. Glob based paths.
  paths:
    - /var/log/*.log
    #- c:\programdata\elasticsearch\logs\*

  # Exclude lines. A list of regular expressions to match. It drops the lines that are
  # matching any regular expression from the list.
  #exclude_lines: ['^DBG']

  # Include lines. A list of regular expressions to match. It exports the lines that are
  # matching any regular expression from the list.
  #include_lines: ['^ERR', '^WARN']

  # Exclude files. A list of regular expressions to match. Filebeat drops the files that
  # are matching any regular expression from the list. By default, no files are dropped.
  #prospector.scanner.exclude_files: ['.gz$']

  # Optional additional fields. These fields can be freely picked
  # to add additional information to the crawled log files for filtering
  #fields:
  #  level: debug
  #  review: 1

# ============================== Filebeat modules ==============================

filebeat.config.modules:
  # Glob pattern for configuration loading
  path: ${path.config}/modules.d/*.yml

  # Set to true to enable config reloading
  reload.enabled: false

  # Period on which files under path should be checked for changes
  #reload.period: 10s

# ======================= Elasticsearch template setting =======================

setup.template.settings:
  index.number_of_shards: 1
  #index.codec: best_compression
  #_source.enabled: false


# ================================== General ===================================

# The name of the shipper that publishes the network data. It can be used to group
# all the transactions sent by a single shipper in the web interface.
#name:

# The tags of the shipper are included in their own field with each
# transaction published.
#tags: ["service-X", "web-tier"]

# Optional fields that you can specify to add additional information to the
# output.
#fields:
#  env: staging

# ================================= Dashboards =================================
# These settings control loading the sample dashboards to the Kibana index. Loading
# the dashboards is disabled by default and can be enabled either by setting the
# options here or by using the `setup` command.
#setup.dashboards.enabled: false

# The URL from where to download the dashboards archive. By default this URL
# has a value which is computed based on the Beat name and version. For released
# versions, this URL points to the dashboard archive on the artifacts.elastic.co
# website.
#setup.dashboards.url:

# =================================== Kibana ===================================

# Starting with Beats version 6.0.0, the dashboards are loaded via the Kibana API.
# This requires a Kibana endpoint configuration.
setup.kibana:

  # Kibana Host
  # Scheme and port can be left out and will be set to the default (http and 5601)
  # In case you specify and additional path, the scheme is required: http://localhost:5601/path
  # IPv6 addresses should always be defined as: https://[2001:db8::1]:5601
  #host: "localhost:5601"

  # Kibana Space ID
  # ID of the Kibana Space into which the dashboards should be loaded. By default,
  # the Default Space will be used.
  #space.id:

# =============================== Elastic Cloud ================================

# These settings simplify using Filebeat with the Elastic Cloud (https://cloud.elastic.co/).

# The cloud.id setting overwrites the `output.elasticsearch.hosts` and
# `setup.kibana.host` options.
# You can find the `cloud.id` in the Elastic Cloud web UI.
cloud.id: "i-o-optimized-deployment:dXMtZWFzdC0xLmF3cy5mb3VuZC5pbyQ4NTcyN2E1MzAwMWY0ZGJhYWViZTJmMTUxZmQ5NTUyNyRmODhlMDdkMDMxOGQ0YTNmYjQ4OThhYzhkNjE0MzVlMg=="

# The cloud.auth setting overwrites the `output.elasticsearch.username` and
# `output.elasticsearch.password` settings. The format is `<user>:<pass>`.
cloud.auth: "elastic:u9efS5ksI6A7ZLw3v3Xg0tyk"

# ================================== Outputs ===================================

# Configure what output to use when sending the data collected by the beat.

# ---------------------------- Elasticsearch Output ----------------------------
output.elasticsearch:
  # Array of hosts to connect to.
  hosts: ["localhost:9200"]

  # Protocol - either `http` (default) or `https`.
  #protocol: "https"

  # Authentication credentials - either API key or username/password.
  #api_key: "id:api_key"
  #username: "elastic"
  #password: "changeme"

# ------------------------------ Logstash Output -------------------------------
#output.logstash:
  # The Logstash hosts
  #hosts: ["localhost:5044"]

  # Optional SSL. By default is off.
  # List of root certificates for HTTPS server verifications
  #ssl.certificate_authorities: ["/etc/pki/root/ca.pem"]

  # Certificate for SSL client authentication
  #ssl.certificate: "/etc/pki/client/cert.pem"

  # Client Certificate Key
  #ssl.key: "/etc/pki/client/cert.key"

# ================================= Processors =================================
processors:
  - add_host_metadata:
      when.not.contains.tags: forwarded
  - dissect:
      when:
        regexp:
          log.file.path: ".*access.*.log.gz"
      tokenizer: '%{@timestamp} %{log.level} "%{event.action} %{user.id} %{event.id} %{http.request.method} %{url.path} %{http.response.status_code} %{duration} %{error}"'
      field: "message"
      target_prefix: "equip"
  - add_fields:
      when:
        regexp:
          log.file.path: ".*nextDay.*.log.gz"
      target: "equip"
      fields:
        event.action: "cron"
        log.level: "error"
  - copy_fields:
      when:
        regexp:
          log.file.path: ".*nextDay.*.log.gz"
      fields:
        - from: message
          to: equip.error
  - add_cloud_metadata: ~

# ================================== Logging ===================================

# Sets log level. The default log level is info.
# Available log levels are: error, warning, info, debug
#logging.level: debug

# At debug level, you can selectively enable logging only for some components.
# To enable all selectors use ["*"]. Examples of other selectors are "beat",
# "publish", "service".
#logging.selectors: ["*"]
logging.level: info
logging.to_files: true
logging.files:
  path: /var/log/filebeat
  name: filebeat
  keepfiles: 7
  permissions: 0644

# ============================= X-Pack Monitoring ==============================
# Filebeat can export internal metrics to a central Elasticsearch monitoring
# cluster.  This requires xpack monitoring to be enabled in Elasticsearch.  The
# reporting is disabled by default.

# Set to true to enable the monitoring reporter.
#monitoring.enabled: false

# Sets the UUID of the Elasticsearch cluster under which monitoring data for this
# Filebeat instance will appear in the Stack Monitoring UI. If output.elasticsearch
# is enabled, the UUID is derived from the Elasticsearch cluster referenced by output.elasticsearch.
#monitoring.cluster_uuid:

# Uncomment to send the metrics to Elasticsearch. Most settings from the
# Elasticsearch output are accepted here as well.
# Note that the settings should point to your Elasticsearch *monitoring* cluster.
# Any setting that is not set is automatically inherited from the Elasticsearch
# output configuration, so if you have the Elasticsearch output configured such
# that it is pointing to your Elasticsearch monitoring cluster, you can simply
# uncomment the following line.
#monitoring.elasticsearch:

# ============================== Instrumentation ===============================

# Instrumentation support for the filebeat.
#instrumentation:
    # Set to true to enable instrumentation of filebeat.
    #enabled: false

    # Environment in which filebeat is running on (eg: staging, production, etc.)
    #environment: ""

    # APM Server hosts to report instrumentation results to.
    #hosts:
    #  - http://localhost:8200

    # API Key for the APM Server(s).
    # If api_key is set then secret_token will be ignored.
    #api_key:

    # Secret token for the APM Server(s).
    #secret_token:


# ================================= Migration ==================================

# This allows to enable 6.7 migration aliases
#migration.6_to_7.enabled: true
```
3. Instalar assets de filebeat
    `filebeat setup -e`
    3.1 Si aparece un error `ERROR instance/beat.go:956 Exiting: 1 error: Error setting up ML for apache_ecs`, se puede ignorar, ya que no usamos machine learning.
4. Ejecutar filebeat
    `systemctl start filebeat`


### Metricbeat
1. Instalar metricbeat a través de APT [Documentación](https://www.elastic.co/guide/en/beats/metricbeat/current/setup-repositories.html)
2. Reemplazar la configuración de metricbeat que se encuentra en `/etc/metricbeat/metricbeat.yml` por el siguiente archivo
```
###################### Metricbeat Configuration Equip  Example #################

# This file is an example configuration file highlighting only the most common
# options. The metricbeat.reference.yml file from the same directory contains all the
# supported options with more comments. You can use it as a reference.
#
# You can find the full configuration reference here:
# https://www.elastic.co/guide/en/beats/metricbeat/index.html

# =========================== Modules configuration ============================

metricbeat.config.modules:
  # Glob pattern for configuration loading
  path: ${path.config}/modules.d/*.yml

  # Set to true to enable config reloading
  reload.enabled: false

  # Period on which files under path should be checked for changes
  #reload.period: 10s

# ======================= Elasticsearch template setting =======================

setup.template.settings:
  index.number_of_shards: 1
  index.codec: best_compression
  #_source.enabled: false


# ================================== General ===================================

# The name of the shipper that publishes the network data. It can be used to group
# all the transactions sent by a single shipper in the web interface.
#name:

# The tags of the shipper are included in their own field with each
# transaction published.
#tags: ["service-X", "web-tier"]

# Optional fields that you can specify to add additional information to the
# output.
#fields:
#  env: staging

# ================================= Dashboards =================================
# These settings control loading the sample dashboards to the Kibana index. Loading
# the dashboards is disabled by default and can be enabled either by setting the
# options here or by using the `setup` command.
#setup.dashboards.enabled: false

# The URL from where to download the dashboards archive. By default this URL
# has a value which is computed based on the Beat name and version. For released
# versions, this URL points to the dashboard archive on the artifacts.elastic.co
# website.
#setup.dashboards.url:

# =================================== Kibana ===================================

# Starting with Beats version 6.0.0, the dashboards are loaded via the Kibana API.
# This requires a Kibana endpoint configuration.
setup.kibana:

  # Kibana Host
  # Scheme and port can be left out and will be set to the default (http and 5601)
  # In case you specify and additional path, the scheme is required: http://localhost:5601/path
  # IPv6 addresses should always be defined as: https://[2001:db8::1]:5601
  #host: "localhost:5601"

  # Kibana Space ID
  # ID of the Kibana Space into which the dashboards should be loaded. By default,
  # the Default Space will be used.
  #space.id:

# =============================== Elastic Cloud ================================

# These settings simplify using Metricbeat with the Elastic Cloud (https://cloud.elastic.co/).

# The cloud.id setting overwrites the `output.elasticsearch.hosts` and
# `setup.kibana.host` options.
# You can find the `cloud.id` in the Elastic Cloud web UI.
cloud.id: "i-o-optimized-deployment:dXMtZWFzdC0xLmF3cy5mb3VuZC5pbyQ4NTcyN2E1MzAwMWY0ZGJhYWViZTJmMTUxZmQ5NTUyNyRmODhlMDdkMDMxOGQ0YTNmYjQ4OThhYzhkNjE0MzVlMg=="

# The cloud.auth setting overwrites the `output.elasticsearch.username` and
# `output.elasticsearch.password` settings. The format is `<user>:<pass>`.
cloud.auth: "elastic:u9efS5ksI6A7ZLw3v3Xg0tyk"

# ================================== Outputs ===================================

# Configure what output to use when sending the data collected by the beat.

# ---------------------------- Elasticsearch Output ----------------------------
output.elasticsearch:
  # Array of hosts to connect to.
  hosts: ["localhost:9200"]

  # Protocol - either `http` (default) or `https`.
  #protocol: "https"

  # Authentication credentials - either API key or username/password.
  #api_key: "id:api_key"
  #username: "elastic"
  #password: "changeme"

# ------------------------------ Logstash Output -------------------------------
#output.logstash:
  # The Logstash hosts
  #hosts: ["localhost:5044"]

  # Optional SSL. By default is off.
  # List of root certificates for HTTPS server verifications
  #ssl.certificate_authorities: ["/etc/pki/root/ca.pem"]

  # Certificate for SSL client authentication
  #ssl.certificate: "/etc/pki/client/cert.pem"

  # Client Certificate Key
  #ssl.key: "/etc/pki/client/cert.key"

# ================================= Processors =================================

# Configure processors to enhance or manipulate events generated by the beat.

processors:
  - add_host_metadata: ~
  - add_cloud_metadata: ~
  - add_docker_metadata: ~
  - add_kubernetes_metadata: ~


# ================================== Logging ===================================

# Sets log level. The default log level is info.
# Available log levels are: error, warning, info, debug
#logging.level: debug

# At debug level, you can selectively enable logging only for some components.
# To enable all selectors use ["*"]. Examples of other selectors are "beat",
# "publish", "service".
#logging.selectors: ["*"]

# ============================= X-Pack Monitoring ==============================
# Metricbeat can export internal metrics to a central Elasticsearch monitoring
# cluster.  This requires xpack monitoring to be enabled in Elasticsearch.  The
# reporting is disabled by default.

# Set to true to enable the monitoring reporter.
#monitoring.enabled: false

# Sets the UUID of the Elasticsearch cluster under which monitoring data for this
# Metricbeat instance will appear in the Stack Monitoring UI. If output.elasticsearch
# is enabled, the UUID is derived from the Elasticsearch cluster referenced by output.elasticsearch.
#monitoring.cluster_uuid:

# Uncomment to send the metrics to Elasticsearch. Most settings from the
# Elasticsearch output are accepted here as well.
# Note that the settings should point to your Elasticsearch *monitoring* cluster.
# Any setting that is not set is automatically inherited from the Elasticsearch
# output configuration, so if you have the Elasticsearch output configured such
# that it is pointing to your Elasticsearch monitoring cluster, you can simply
# uncomment the following line.
#monitoring.elasticsearch:

# ============================== Instrumentation ===============================

# Instrumentation support for the metricbeat.
#instrumentation:
    # Set to true to enable instrumentation of metricbeat.
    #enabled: false

    # Environment in which metricbeat is running on (eg: staging, production, etc.)
    #environment: ""

    # APM Server hosts to report instrumentation results to.
    #hosts:
    #  - http://localhost:8200

    # API Key for the APM Server(s).
    # If api_key is set then secret_token will be ignored.
    #api_key:

    # Secret token for the APM Server(s).
    #secret_token:


# ================================= Migration ==================================

# This allows to enable 6.7 migration aliases
#migration.6_to_7.enabled: true
```
3. Instalar assets de metricbeat
    `metricbeat setup -e`
    3.1 Si aparece un error `ERROR instance/beat.go:956 Exiting: 1 error: Error setting up ML for apache_ecs`, se puede ignorar, ya que no usamos machine learning.
4. Ejecutar filebeat
    `systemctl start metricbeat`
    
## ¿Cómo gestionar la ejecución de filebeat o metricbeat?
- Hay que utilizar systemctl para gestionar ambos procesos
    `systemctl start filebeat`
    `systemctl stop filebeat`
    `systemctl status filebeat`
    `systemctl start metricbeat`
    `systemctl stop metricbeat`
    `systemctl status metricbeat`
- Aparentemente si cambiamos la configuración de un servicio, es necesario actualizar systemd (Ejemplo con filebeat)
    ```
    systemctl stop filebeat
    nano filebeat.yml
    filebeat test config
    systemctl daemon-reload
    systemctl start filebeat
    ```
## Branches utilizadas para testear
- La branch de la web no contiene cambios, pero es la última compatible con la api
- La api contiene: cambios en el loggeo y errores en distintas partes del código (accion prioritize y errores en el cron)
- https://github.com/Equip-Collaboration/equip_api/tree/badBranch
- https://github.com/Equip-Collaboration/equip_web/tree/badBranch
