map.apps Nutzerinteraktionen

Übersicht

map.apps usage

Die map.apps Nutzer-Interaktionen können per Ingest- und per Logstash-Pipeline erfasst werden, wobei die Ingest-Pipeline die bevorzugte Methode ist.

Die Ingest-Pipeline ct-monitor-analytics ist in der Lage, die Nutzer-Interaktionen zu normalisieren und zu pseudonymisieren, bevor sie in Elasticsearch gespeichert werden.

Die Logstash-Pipeline ct-analytics ist eine alternative Methode, welche nun abgekündigt ist und zwecks Rückwärtskompatibilität weiterhin unterstützt wird.

Ablauf

  1. Konfiguration der Ingest-Pipeline ct-monitor-analytics oder der Logstash-Pipeline ct-analytics

  2. Hochladen der Analytics-Bundles in map.apps Manager

  3. Konfiguration von map.apps

Analytics Bundles hochladen

Um die Bundles zur Erfassung von Interaktionsdaten von service.monitor zu nutzen, installieren Sie diese im map.apps Manager.

  1. Loggen Sie sich als Admin im map.apps Manager ein.

  2. Wechseln Sie zum Bundles Tab.

  3. Klicken Sie + Erstellen und wählen Sie die Datei ct-monitor-analytics-js-[VERSION].jar aus.

Konfiguration von map.apps

Neben dem Upload der Bundles, müssen Sie die unten aufgeführten Eigenschaften in der application.properties von map.apps hinzufügen oder ändern. Starten Sie anschließend den Servlet Container neu oder aktualisieren Sie den Kontext.

Der Pfad des map.apps data.directory.location unterscheidet sich von dem des service.monitor.
application.properties (map.apps)
#### service.monitor Integration
analytics.service.url=/monitor-analytics/resources/usage/log
analytics.message.src=map.apps
appservice.default.bundles=analytics_restservice

servicemonitor.base.url=/monitor
analytics.management.role=maAdmin
analytics.service.url

HTTP-Endpunkt zum Erfassen von Nutzungsdaten durch die service.monitor Usage Log Webapp.

analytics.message.src

Name der Nachrichtenquelle (für spätere Analysen).

Property-Status: neu
Default: map.apps

appservice.default.bundles

Bundles, die für jede angelegte App geladen werden.

Wenn Sie die Eigenschaft um das analytics_restservice Bundle ergänzen, senden alle Apps standardmäßig die erfassten Daten an die analytics.service.url. Dies geschieht auch dann, wenn das analytics_restservice Bundle nicht im allowedBundles-Bereich der App gelistet wird und vereinfacht so die einmalige Aktivierung vom service.monitor für alle Apps.

Wenn Sie eine App über die Live-Konfiguration in map.apps bearbeiten und speichern, werden die hier aufgeführten Bundles zur app.json hinzugefügt. Diese Änderung bleibt auch dann erhalten, wenn Bundles wieder aus der appservice.default.bundles Liste entfernt werden.

Diese Eigenschaft wird nur für Apps angewendet, die über den map.apps App Dienst bereitgestellt werden, und nicht für Apps, die im Dateisystem gespeichert sind.

Property-Status: warning liegt möglicherweise schon in der Datei vor
Default: analytics_restservice (seit map.apps 4.16)

Default: system,templatelayout,analytics_restservice

servicemonitor.base.url

HTTP-Endpunkt zum Aufruf der /monitor-Webapp innerhalb des map.apps Managements.

Property-Status: neu
Default: https://monitoring-host.example.com/monitor

analytics.management.role

Name einer Rolle die für die Anzeige der /monitor Webapp im map.apps Manager nötig ist.

Property status: new
Default: maAdmin

Sollte map.apps und service.monitor nicht auf einem gemeinsamen Host betrieben werden, fügen Sie den entsprechenden Host den allowedProxyUrls in der map.apps application.properties Datei hinzu.

Aktivierung des Loggings pro App

Um die Protokollierung für eine einzelne App zu aktivieren, fügen Sie ein Bundle mit der Komponente writer (z.B. analytics_restservice) zum Abschnitt allowedBundles in der app.json hinzu. Nutzen Sie appservice.default.bundles, um stattdessen die Protokollierung für alle Anwendungen zu aktivieren.

app.json
{
  "load": {
    "allowedBundles": [
      ...
      "analytics_restservice"
    ]
  }
  ...
}