Automatyczna instrumentacja serwisu WWW

Krok 1: Tworzenie serwisów WWW

Aby utworzyć serwisy WWW, które mają być monitorowane, wykonaj następujące kroki:

1. W interfejsie użytkownika Instana przejdź do opcji Serwisy WWW i aplikacje mobilne i kliknij opcję Dodaj serwis WWW.

2. Wprowadź nazwę serwisu WWW, a następnie kliknij opcję Dodaj serwis WWW.

   

3. Od Wszystko jest gotowe! zapisz wartości parametrów reportingUrl, keyi jsAgentUrl. Należy podać te wartości w pliku konfiguracyjnym <instana-agent-dir>/etc/instana/configuration.yaml agenta Instana w kroku 2.

   

Krok 2: Modyfikowanie pliku konfiguracyjnego agenta

Należy zmodyfikować plik <instana-agent-dir>/etc/instana/configuration.yaml agenta Instana, w którym znajduje się serwer Apache HTTP Server . Następujące ustawienia konfiguracyjne dla automatycznej instrumentacji serwisu WWW są dostępne w pliku configuration.yaml agenta Instana:

#EUM
#com.instana.plugin.eum:
#  instrumentation:
#    #contentTypes:                       # List of the 'Content-Type' values for matching requests that need to be instrumented,
#                                         #  default values in the list are 'text/html' and 'application/xhtml+xml'.
#    #  - 'text/html'
#    #  - 'application/xhtml+xml'
#    #aggressive: false                   # Indicates whether to instrument with the EUM JavaScript agent if Instana cannot determine
#                                         # the 'Content-Type' of the request, default is false.
#    #######################################################################################################
#    # Following parameters are used as common EUM monitoring configuration.
#    # They can be overwritten by specifying them in the website configuration.
#    #######################################################################################################
#    jsAgentUrl: 'https://eum.instana.io/eum.min.js' # EUM JavaScript agent download URL.
#    reportingUrl: <reportingUrl>                    # The URL to which to send website monitoring data to.
#    trackSessions: true                             # Indicates whether to enable session tracking, default is true.
#    #######################################################################################################
#    # Following parameters are used to configure each monitored website.
#    # Optional parameters are commented out by default. Remove the hashtag (#) when needed.
#    #######################################################################################################
#    websites:
#      - name: <WEBSITE_NAME>             # Name of the website for the website configuration in Instana.
#        key: <WEBSITE_KEY>               # Monitoring key for the website configuration in Instana.
#        #enabled: true                   # Indicates whether to enable website monitoring on this website, default is true.
#        #reportingUrl: <reportingUrl>    # The URL to which to send website monitoring data to. Overwrites upper-level setting.
#        #jsAgentUrl: 'https://eum.instana.io/eum.min.js' # JavaScript agent download URL. Overwrites upper-level setting.
#        #trackSessions: true             # Indicates whether to enable session tracking, default is true. Overwrites upper-level setting.
#        #mode: 'regular'                 # Mode for monitoring data transmission, default is 'regular'.
#                                         # Available mode is 'regular'.
#        selector:                        # List of match expressions to filter requests.
#          matchExpressions:              # When all match expressions are evaluated to true, the request is monitored.
#                                         # At least one match expression with the key of the 'url' catalog must be defined.
#            - key: 'url/hostname'        # Key specified in the <catalog>/<resource> format.
#                                         # Available catalogs in the key include 'url' for request filtering plus
#                                         #  'container' and 'k8s' for Web Server infrastructure filtering.
#                                         # Available keys:
#                                         #  'url/hostname', 'url/path', and 'url/filename'
#                                         #  'container/name' and 'container/imagename'
#                                         #  'k8s/namespace', 'k8s/podname', and 'k8s/containername'
#              operator: 'Equals'         # Match expression operators: 'Contains', 'ContainsIgnoreCase', 'Equals',
#                                         #  'EqualsIgnoreCase', 'StartWith', and 'StartWithIgnoreCase'.
#              values:                    # List of match expression values.
#                - 'example.com'

Postępuj zgodnie z komentarzami w każdej linii, aby skonfigurować automatyczną instrumentację strony internetowej EUM. Patrz następujący przykład:

com.instana.plugin.eum:
  instrumentation:
    jsAgentUrl: 'https://eum.instana.io/eum.min.js'
    reportingUrl: 'https://eum.example.com'
    trackSessions: true
    websites:
      - name: demo
        key: YOURWEBSITEKEYHERE
        selector:
          matchExpressions:
            - key: 'url/hostname'
              operator: 'Equals'
              values:
                - 'example.com'

W tym przykładzie konfiguracja umożliwia monitorowanie serwisów WWW dla wszystkich żądań HTTP kierowanych do hosta o nazwie example.com. Wygenerowane sygnalizatory są wysyłane do serwisu WWW demo z kluczem YOURWEBSITEKEYHERE w adresie URL raportowania https://eum.example.com.

Po zapisaniu zmodyfikowanego pliku configuration.yaml automatycznie pobierany i instalowany jest moduł HTTPd EUM. Moduł można zweryfikować, sprawdzając plik instana_tracing.conf w katalogu konfiguracyjnym HTTPd.

Krok 3: Zrestartuj serwer WWW

Jeśli parametr autoRestart jest ustawiony na wartość true w śledzeniu HTTPd, nie trzeba ręcznie restartować serwera HTTP Server Apache .

com.instana.plugin.httpd:
  tracing:
    autoRestart: true

W przeciwnym razie należy poprawnie zrestartować serwer Apache HTTP Server , aby załadować moduł EUM.

Krok 4: Sprawdzanie poprawności na panelu kontrolnym serwisu WWW

Upewnij się, że obciążenia są obecne w serwisie WWW, a następnie przejdź do panelu kontrolnego serwisu WWW w interfejsie użytkownika Instana, aby sprawdzić, czy dane monitorowania zostały odebrane.

Przykłady filtrowania żądań na wielu hostach wirtualnych

W poniższych przykładach przedstawiono sposób definiowania wyrażeń zgodności w celu zapewnienia automatycznego instrumentowania serwisów WWW w przypadku wielu hostów VirtualHost w konfiguracji HTTPd serwera Apache .

Na przykład patrz następująca definicja VirtualHost :

Listen 80
<VirtualHost *:80>
    DocumentRoot "/www/example1"
    ServerName www.example.com

    # Other directives here
</VirtualHost>

<VirtualHost *:80>
    DocumentRoot "/www/example2"
    ServerName www.example.org

    # Other directives here
</VirtualHost>

com.instana.plugin.eum:
  instrumentation:
    jsAgentUrl: 'https://eum.instana.io/eum.min.js'
    reportingUrl: 'https://eum.example.com'
    trackSessions: true
    websites:
      - name: 'website1'
        key: 'WEBSITEKEY1'
        selector:
          matchExpressions:
            - key: 'url/hostname'
              operator: 'Equals'
              values:
                - 'www.example.com'
      - name: 'website2'
        key: 'WEBSITEKEY2'
        selector:
          matchExpressions:
            - key: 'url/hostname'
              operator: 'Equals'
              values:
                - 'www.example.org'

com.instana.plugin.eum:
  instrumentation:
    jsAgentUrl: 'https://eum.instana.io/eum.min.js'
    reportingUrl: 'https://eum.example.com'
    trackSessions: true
    websites:
      - name: 'website1'
        key: 'WEBSITEKEY1'
        selector:
          matchExpressions:
            - key: 'url/filename'
              operator: 'StartWith'
              values:
                - '/www/example1'
      - name: 'website2'
        key: 'WEBSITEKEY2'
        selector:
          matchExpressions:
            - key: 'url/filename'
              operator: 'StartWith'
              values:
                - '/www/example2'

com.instana.plugin.eum:
  instrumentation:
    jsAgentUrl: 'https://eum.instana.io/eum.min.js'
    reportingUrl: 'https://eum.example.com'
    trackSessions: true
    websites:
      - name: 'website1'
        key: 'WEBSITEKEY1'
        selector:
          matchExpressions:
            - key: 'url/hostname'
              operator: 'Equals'
              values:
                - 'www.example.com'
            - key: 'url/path'
              operator: 'StartWith'
              values:
                - '/products'
                - '/carts'
      - name: 'website3'
        key: 'WEBSITEKEY3'
        selector:
          matchExpressions:
            - key: 'url/hostname'
              operator: 'Equals'
              values:
                - 'www.example.com'
            - key: 'url/path'
              operator: 'StartWith'
              values:
                - '/offers'
                - '/employees'
      - name: 'website2'
        key: 'WEBSITEKEY2'
        selector:
          matchExpressions:
            - key: 'url/filename'
              operator: 'StartWith'
              values:
                - '/www/example2'

Przykłady filtrowania infrastruktury

W poniższych przykładach przedstawiono sposób definiowania wyrażeń zgodności w celu zapewnienia automatycznego instrumentowania serwisów WWW w konkretnym wdrożeniu infrastruktury.

Uwaga: W przeciwieństwie do filtrowania żądań, filtrowanie infrastruktury jest opcjonalne.

com.instana.plugin.eum:
  instrumentation:
    jsAgentUrl: 'https://eum.instana.io/eum.min.js'
    reportingUrl: 'https://eum.example.com'
    trackSessions: true
    websites:
      - name: 'containerized website'
        key: 'WEBSITEKEY1'
        selector:
          matchExpressions:
            - key: 'url/hostname'
              operator: 'Equals'
              values:
                - 'www.example.com'
            - key: 'container/name'
              operator: 'Equals'
              values:
                - 'example-app'

com.instana.plugin.eum:
  instrumentation:
    jsAgentUrl: 'https://eum.instana.io/eum.min.js'
    reportingUrl: 'https://eum.example.com'
    trackSessions: true
    websites:
      - name: 'k8s website'
        key: 'WEBSITEKEY1'
        selector:
          matchExpressions:
            - key: 'url/hostname'
              operator: 'Equals'
              values:
                - 'www.example.com'
            - key: 'k8s/namespace'
              operator: 'Equals'
              values:
                - 'prod-example'
            - key: 'k8s/podname'
              operator: 'Equals'
              values:
                - 'example-pod'
            - key: 'k8s/containername'
              operator: 'Equals'
              values:
                - 'example-app'