NGINX 'in İzlenmesi

NGINX için ölçümler

NGINX metrik derlemi için, YönOrtamıuzak metrik derlemi için ngx_http_stub_status_module öğesini kullanır. Bu kaynak grubunu etkinleştirmek için modülün etkinleştirildiğinden ya da kullanılabilir olduğundan emin olun ve NGINX yapılandırmanızın başına aşağıdaki parçacığı ekleyin:

location /nginx_status {
  stub_status  on;
  access_log   off;
  allow 127.0.0.1; # Or the Remote IP of the Instana Host Agent
  deny  all;
}

Varsayılan olarak, YönOrtamıaracı kullanılabilir işlem bağımsız değişkenlerinde yapılanış dosyasının yerini arar; tersi durumda /etc/nginx/nginx.conf' e geri çevrilir.

Not: Instana aracısı bir Kubernetes kümesinde çalıştığında, allow <host-ip-address> yapılandırmasını kullanarak aracının çalıştığı anasistem IP adresine izin verdiğinizden emin olun.

NGINX Plus için ölçümler

NGINX Plus metrik izlemesini etkinleştirmek için, ngx_http_api_module (*) kurulu ya da kullanılabilir olduğundan emin olun ve modülü etkinleştirmek için aşağıdaki bloğu ekleyin:

location /api {
    api write=off;
    allow 127.0.0.1; # Or the Remote IP of the Instana Host Agent
    deny all;
}

Kubernetes için Ölçümler-Giriş NGINX

Kubernetes Ingress NGINX sürüm 0.23.0 ' dan itibaren, 18080 kapısında dinleyen sunucu devre dışı bırakıldı. Instana 'nın bu NGINX eşgörünümünü izlemesi için, Configmap 'e aşağıdaki parçacığı ekleyerek sunucuyu geri yükleyin:

http-snippet: |
  server {
    listen 18080;

    location /nginx_status {
      stub_status on;
      access_log  off;
      allow 127.0.0.1; # Or the Remote IP of the Instana Host Agent
      deny  all;
    }

    location / {
      return 404;
    }
  }

Daha fazla bilgi için bkz. NGINX Giriş Yayın Notları.

1. İkili dosyaları karşıdan yükle

NGINX HTTP izleme modülleri, daha fazla işlev ve daha kolay kullanım sağlayan özelleştirmelerle nginx-opentracing v0.22.1 modülünü temel alır.

NGINX 'in desteklenen dağıtımlarına ilişkin instana ikili dosyalarına ilişkin yükleme bağlantıları NGINX Distributed Tracing Binaries (NGINX Dağıtımlı İzleme İkili Dosyaları) sayfasında bulunur.

2. İkili dosyaları kopyalayın

Önceki adımda karşıdan yüklenen ve ayıklanan iki ikili dosya, hem konum hem de dosya izinleri açısından NGINX işleminin erişebileceği bir dosya sistemine yerleştirilmelidir.

NGINX, bir kapsayıcıda çalıştırmanın aksine, doğrudan işletim sisteminde çalışıyorsa, genellikle iki YönOrtamı'ndakilerin diğer NGINX modüllerini içeren klasöre kopyalanması iyi bir seçenektir. NGINX 'in, nginx -V komutunu çalıştırarak ve --modules-path yapılandırma seçeneğini arayarak modüllerin nerede bulunmasını beklediğini bulabilirsiniz; örneğin, StackOverflowüzerindeki bu yanıta bakın.

Kapsayıcı bir ortamda, bu uygulama bunları kapsayıcı görüntüsüne eklemek veya dosyaları birimler olarak kapsayıcıya bağlamak anlamına gelebilir; örneğin, Docker ' ın bağlama bağlamaları belgelerine ya da birimlerin Kubernetesiçindeki bölgelere nasıl bağlanacağına bakın.

3. NGINX yapılandırmalarını düzenle

NGINX 'in desteklenen her sürümünde, biri GLIBC için, diğeri MUSLiçin olmak üzere iki ayrı Zipped Archives vardır. GLIBC , MUSLgerektiren Alpinedışındaki tüm Linux Distros içindir.

NGINX 'i aşağıdaki gibi yapılandırmadan önce, karşıdan yüklenen modülü modules/ngx_http_opentracing_module.so olarak yeniden adlandırmanız ya da karşıdan yüklenen modül adına dayalı olarak nginx.conf dosyasında yapılandırma satırını load_module modules/ngx_http_opentracing_module.so; değiştirmeniz gerekir. Örneğin, load_module modules/ngx_http_opentracing_module.so; yapılanış satırını load_module modules/musl-nginx-1.23.3-ngx_http_ot_module.so;olarak değiştirin.

# The following line adds the basic module Instana uses to get tracing data.
# It is required that you use the version of this module built by Instana,
# rather than the one shipped in many NGINX distros, as there are some
# modifications in the Instana version that are required for tracing to work
load_module modules/ngx_http_opentracing_module.so;

# Whitelists environment variables used for tracer configuration to avoid
# that NGINX wipes them. This is only needed if instana-config.json
# should contain an empty configuration with "{}" inside to do the
# configuration via these environment variables instead.
env INSTANA_SERVICE_NAME;
env INSTANA_AGENT_HOST;
env INSTANA_AGENT_PORT;
env INSTANA_MAX_BUFFERED_SPANS;
env INSTANA_DEV;

events {}

error_log /dev/stdout info;

http {
  error_log /dev/stdout info;

  # The following line loads the Instana libsinstana_sensor library, that
  # gets the tracing data from ngx_http_opentracing_module.so and converts
  # them to Instana AutoTrace tracing data.
  # The content of instana-config.json is discussed as follows.
  opentracing_load_tracer /usr/local/lib/libinstana_sensor.so /etc/instana-config.json;

  # Propagates the active span context for upstream requests.
  # Without this configuration, the Instana trace will end at
  # NGINX, and the systems downstream (those to which NGINX
  # routes the requests) monitored by Instana will generate
  # new, unrelated traces
  opentracing_propagate_context;

  # Optional: This logs subrequests like e.g. created by the `auth_request`
  # directive so that authorization requests can be traced.
  log_subrequest on;

  # If you use upstreams, Instana will automatically use them as endpoints,
  # and it is really cool :-)
  upstream backend {
    server server-app:8080;
  }

  server {
    error_log /dev/stdout info;
    listen 8080;
    server_name localhost;

    location /static {
      root /www/html;
    }

    location ^~ /api {
      proxy_pass http://backend;
    }

    location ^~ /other_api {
      proxy_set_header X-AWESOME-HEADER "truly_is_awesome";

      # Using the `proxy_set_header` directive voids for this
      # location the `opentracing_propagate_context` defined
      # at the `http` level, so here it needs to be set again.
      # It needs to be set for every block where `proxy_set_header`
      # is found. This can also be the case at `server` level.
      opentracing_propagate_context;

      proxy_pass http://backend;
    }
  }
}

Özel durum opentracing_propagate_context:

Ana (http) düzeyin yanı sıra, proxy_set_header yönergesinin de ayarlandığı her blok (server ya da location) için opentracing_propagate_context yönergesinin eklenmesi gerekir. Bunun nedeni, OpenTracing bağlam yayılımının dahili olarak proxy_set_header ' e dayanması ve aksi takdirde bu bağlam tarafından geçersiz hale gelmesinden gelir. Bu, NGINX modülü API 'sinin bir sınırlamasıdır.

Aşağıda bir instana-config.jsonörneği verilmiştir:

{
  "service": "nginxtracing_nginx", # Change this line to give your NGINX service a different name in Instana
  "agent_host": <host_agent_address>, # Change this line with the IP address or DNS name of the Instana agent on the same host as your NGINX process
  "agent_port": 42699, # This is the default, and you should never change it unless instructed by the Instana support
  "max_buffered_spans": 1000
}

Yukarıdaki parçacıkta yer alan yapılandırmalar aşağıdakiler anlamına gelir:

• service: YönOrtamıana arka ucunda bu NGINX işlemiyle ilişkilendirilecek ad. Belirtilmezse, hizmet adları HTTP anasistem adı ya da diğer yollaradayalı olarak hesaplanır.
• agent_host: yerel anasistem aracısının IP adresi ya da DNS adı. Bu yapılanışı, NGINX işlemiyle aynı anasistemdeki YönOrtamıaracının ağ adıyla eşleşecek şekilde değiştirmelisiniz.
• agent_port: NGINX izleme uzantısının anasistem aracısıyla iletişim kurmaya çalışacağı kapı. Bu kapının yapılandırılamayan aracı tarafı olduğuna dikkat edin. NGINX izleme uzantısı, kapı iletme ya da kapı eşleme gerektiren ayarlarda bu uzantıyı yapılandırmanızı sağlar.
• max_buffered_spans: İstek başına bir adet olmak üzere, NGINX izleme uzantısının aracıyı aracıya göndermeden önce yerel olarak tutacağı yayılma miktarı üst sınırı; varsayılan değer 1000' dir. NGINX izleme uzantısı, yerel arabelleğe alınan her saniye için sifonu çekecektir. Bu ayar, NGINX sunucunuz saniyede 1000 'dan fazla istek sunarken ve izleme verilerini daha hızlı temizleyerek NGINX sunucunuzun bellek alanını azaltmak istediğinizde yerel arabelleğe alma miktarını azaltmanızı sağlar.

Diğer seçenek, izleyiciyi ortam değişkenleriyle yapılandırmaktır. Bunlar önceliklidir, ancak instana-config.json kütüğü gereklidir. Aşağıdakileri yapın:

• boş bir yapılandırmayı {} instana-config.json içine koyma
• Yukarıda gösterildiği gibi, NGINX yapılandırmasında ortam değişkenlerinin beyaz listesini yapın
• NGINX 'i başlatmadan önce ortam değişkenlerini ayarla

Bu yöntem, özellikle bir Kubernetes kümesinde YönOrtamıcı aracısı anasistemini anasistem IP 'sine ayarlamak için yararlıdır.

Aşağıdaki örnek Kubernetes devreye alma YAML kısmı bu yöntemi gösterir:

        env:
        - name: INSTANA_SERVICE_NAME
          value: "nginxtracing_nginx"
        - name: INSTANA_AGENT_HOST
          valueFrom:
            fieldRef:
              fieldPath: status.hostIP

Daha fazla bilgi için bkz. Ortam değişkeni başvurusu.

4. Yeniden başlat ya da yeniden yükle

Bir reload komutu göndererek NGINX işlemini yeniden başlatın ya da yapılandırmayı yeniden yüklemeyi tetikleyin .

W3C İzleme bağlamı için destek

NGINX Tracer 1.8.0sürümünden bu yana W3C İzleme Bağlamı üstbilgilerinin yayılması için destek sağlanır.

Diğer NGINX OpenTracing modül oluşturmaları için destek

NGINX 'in kendisi tarafından desteklenenler de dahil olmak üzere, 3rd taraflardan NGINX OpenTracing modülünün oluşturmalarının kullanılması desteklenmez. NGINX OpenTracing modülünün Instana oluşturmasının gerekmesinin nedenleri şunlardır: Teknik: Kendi kendine derleme desteklenmez (kendi sürümünüzü oluşturmanız); bu, derleme işleminde tamamen farklı ve öngörülemeyen ayarlarda neyin yanlış gittiğini denemek ve anlamak için gereksiz yere YönOrtamı'nınn desteğini zorlar; benzer şekilde, F5 tarafından sağlanan modüller desteklenmez. Çünkü bunlar, YönOrtamıana izleme gereksinimlerinin ve standart C++ kitaplığına dinamik bağlantı kullanan ve çoğu durumda segfault' a yol açabilecek işlevlerden yoksundur. Gerçekten de, segfault olmasını önlemek için, Instana NGINX OpenTracing modülü, testi birleştirmek ve eski dağıtımlarda bile modern C++ kodunun yararına olmak üzere statik olarak bağlantılı bir standart C++ kitaplığı da dahil olmak üzere oluşturulmuştur.