Udostępnij za pośrednictwem

Dokumentacja ustawień dzienników diagnostycznych: API Management

  • Artykuł

DOTYCZY: Wszystkie warstwy usługi API Management

W tej dokumentacji opisano ustawienia rejestrowania diagnostycznego interfejsu API z wystąpienia usługi API Management. Aby włączyć rejestrowanie żądań interfejsu API, zobacz następujące wskazówki:

Uwaga

Niektóre ustawienia, o których wspomniano, mają zastosowanie tylko do rejestrowania w usłudze Application Insights.

Ustawienie Type Opis
Włącz boolean Określa, czy rejestrowanie tego interfejsu API jest włączone.

Rejestrowanie można włączyć dla wszystkich interfejsów API lub dla pojedynczego interfejsu API. Ustawienia poszczególnych interfejsów API zastępują ustawienia dla wszystkich interfejsów API, jeśli są włączone.
Element docelowy rejestrator aplikacja systemu Azure Insights Określa rejestrator, który ma być używany do rejestrowania usługi Application Insights.
Próbkowanie (%) decimal Wartości z zakresu od 0 do 100 (procent).
Określa procent zarejestrowanych żądań. Próbkowanie 0% oznacza zero zarejestrowanych żądań, podczas gdy próbkowanie w 100% oznacza wszystkie zarejestrowane żądania. Ustawienie domyślne: 100

Aby uzyskać informacje na temat wpływu rejestrowania usługi Application Insights na wydajność, zobacz Wpływ na wydajność i próbkowanie dzienników.
Zawsze rejestruj błędy boolean Jeśli to ustawienie jest włączone, wszystkie błędy są rejestrowane, niezależnie od ustawienia Próbkowanie .
Adres IP klienta dziennika boolean Jeśli to ustawienie jest włączone, rejestrowany jest adres IP klienta dla żądań interfejsu API.
Poziom szczegółowości Określa szczegółowość dzienników i określa, czy są rejestrowane niestandardowe ślady skonfigurowane w zasadach śledzenia .

* Błąd — nieudane żądania i niestandardowe ślady ważności error
* Informacje — żądania zakończone niepowodzeniem i pomyślne oraz niestandardowe ślady ważności error i information
* Pełne — żądania zakończone niepowodzeniem i pomyślne oraz niestandardowe ślady ważności error, informationi verbose

Ustawienie domyślne: Informacje
Protokół korelacji Określa protokół używany do korelowania danych telemetrycznych wysyłanych przez wiele składników do usługi Application Insights. Ustawienie domyślne: Starsza wersja

Aby uzyskać informacje, zobacz Korelacja telemetrii w usłudze Application Insights.
Nagłówki do rejestrowania lista Określa nagłówki rejestrowane dla żądań i odpowiedzi. Ustawienie domyślne: żadne nagłówki nie są rejestrowane.
Liczba bajtów ładunku (treść) do zarejestrowania integer Określa liczbę początkowych bajtów zarejestrowanego żądania frontonu lub zaplecza lub treści odpowiedzi. Maksimum: 8192. Wartość domyślna: 0
Żądanie frontonu Określa, czy żądania frontonu (żądania przychodzące do bramy usługi API Management) są rejestrowane.

Jeśli to ustawienie jest włączone, określ nagłówki do rejestrowania, liczbę bajtów ładunku do dziennika lub oba te elementy.
Odpowiedź frontonu Określa, czy są rejestrowane odpowiedzi frontonu (odpowiedzi wychodzące z bramy usługi API Management).

Jeśli to ustawienie jest włączone, określ nagłówki do rejestrowania, liczbę bajtów ładunku do dziennika lub oba te elementy.
Żądanie zaplecza Określa, czy są rejestrowane żądania zaplecza (żądania wychodzące z bramy usługi API Management).

Jeśli to ustawienie jest włączone, określ nagłówki do rejestrowania, liczbę bajtów ładunku do dziennika lub oba te elementy.
Odpowiedź zaplecza Określa, czy są rejestrowane odpowiedzi zaplecza (odpowiedzi przychodzące do bramy usługi API Management).

Jeśli to ustawienie jest włączone, określ nagłówki do rejestrowania, liczbę bajtów ładunku do dziennika lub oba te elementy.

Ważne

W przypadku włączenia zarejestrowanych ładunków żądań lub odpowiedzi może być maksymalnie 8192 bajtów. Usługa API Management wymusza również limit 32 KB dla wpisu dziennika diagnostycznego wysyłanego do usługi Azure Monitor, który obejmuje ładunki i inne atrybuty, takie jak kody stanu, nagłówki i znaczniki czasu. Jeśli łączny rozmiar atrybutów przekracza 32 KB, usługa API Management przycina wpis przez usunięcie całej zawartości treści i śledzenia.

Następne kroki

  • Aby uzyskać więcej informacji, zobacz dokumentację jednostki diagnostycznej w interfejsie API REST usługi API Management.
  • Użyj zasad śledzenia, aby dodać niestandardowe ślady do danych telemetrycznych, dzienników zasobów lub śledzenia żądań usługi Application Insights.