Elasticsearch (SaaS)

The Elasticsearch integration allows you to create a read-only user to use with your favorite reporting tool (e.g. like Grafana).

If you want to take full advantage of the Zammad reporting, have a look at our Grafana setup page as well.

Warnung

🚧 Spezifisch für die gehostete Umgebung 🚧

Diese Integration steht nur in gehosteten Umgebungen zur Verfügung. Um Elasticsearch nutzen zu können, benötigen Sie ein Plus Abonnement.

Selbstgehostete Nutzer haben die gesamte Kontrolle über ihre selbst gehosteten Elasticsearch-Instanzen.

Elasticsearch integration page on SaaS environments

Limitierungen

Bitte beachten Sie die folgenden Limitierungen für den Elasticsearch-Zugriff auf gehosteten Umgebungen:

  • der Zugriff auf Elasticsearch-Indexe ist ein lesender Zugriff

  • Sie sind zur Zeit auf einen Benutzer beschränkt

  • Reporting-Tools die Schreibzugriff auf Indexen benötigen (wie Kibana) werden nicht unterstützt

  • IP-Zugriffsbeschränkung wird zur Zeit noch nicht unterstützt

Activating Elasticsearch access

By default external access to your Elasticsearch index is not active. You can enable the integration at any time if needed.

Please ensure to note down the password provided - you won’t have access to it afterwards.

Screencast showing activation of Elasticsearch integration

Connection Settings

This section holds the most important general information for accessing your Elasticsearch indexes - such as:

URL

A unique subdomain that does not tell your real instance URL.

Software

The major version of the search index being used. This is required by some Reporting tools like Grafana.

Authentifizierung

The authentication type being supported. Basic Authentication

Verfügbare Indexe

Within this section we’re displaying the -in our opinion- most important indexes for a Zammad instance.

Tipp

If you require all indexes or our listing is not good enough for you, point your browser to the URL we’re providing and append /_aliases?pretty=true. The result should look like so: https://<URL>.zammad.com/_aliases?pretty=true.

Your browser will automatically ask for your credentials - you’ll then see something like this:

{
   "XXXXXXXX" : {
      "aliases" : { }
   },
   "XXXXXXXX_cti_log" : {
      "aliases" : { }
   },
   "XXXXXXXX_knowledge_base_answer_translation" : {
      "aliases" : { }
   },
   "XXXXXXXX_ticket" : {
      "aliases" : { }
   },
   "XXXXXXXX_knowledge_base_category_translation" : {
      "aliases" : { }
   },
   "XXXXXXXX_knowledge_base_translation" : {
      "aliases" : { }
   },
   "XXXXXXXX_ticket_state" : {
      "aliases" : { }
   },
   "XXXXXXXX_user" : {
      "aliases" : { }
   },
   "XXXXXXXX_stats_store" : {
      "aliases" : { }
   },
   "XXXXXXXX_chat_session" : {
    "aliases" : { }
   },
   "XXXXXXXX_group" : {
    "aliases" : { }
   },
   "XXXXXXXX_ticket_priority" : {
      "aliases" : { }
   },
   "XXXXXXXX_organization" : {
      "aliases" : { }
   }
}

Zugangsdaten

Within this section Zammad displays your available users. The password is provided once (upon activation) and cannot be retrieved after that.

Bemerkung

🔐 I need my Elasticsearch user password to be changed

Currently setting the integration to inactive and back to active again does the trick. We’re working on a better solution!

🤓 Above does not change indexes.