Validera och felsöka med Dispatcher Tools (Legacy) Dispatcher-tools-legacy

Introduktion apache-and-dispatcher-configuration-and-testing

I följande avsnitt beskrivs filstrukturen för det äldre läget, lokal validering, felsökning och hur du migrerar från det äldre läget till det flexibla läget.

I den här artikeln förutsätts att ditt projekts Dispatcher-konfiguration inte innehåller filen opt-in/USE_SOURCES_DIRECTLY. Det innebär att antalet filer och deras storlek begränsas, till exempel:

Från och med Cloud Manager 2021.7.0 genererar nya Cloud Manager-program maven projektstrukturer med AEM 28 eller högre, som innehåller den tidigare nämnda filen.

Vi rekommenderar starkt att du migrerar från äldre läge till flexibelt läge enligt anvisningarna i migreringsavsnittet Migrera från äldre läge till flexibelt läge. Om du använder ett flexibelt läge valideras och distribueras konfigurationen på ett bättre sätt av SDK och runtime.

Filstruktur legacy-mode-file-structure

Strukturen för projektets Dispatcher-undermapp (i äldre läge) är följande:

./
├── conf.d
│   ├── available_vhosts
│   │   └── default.vhost
│   ├── dispatcher_vhost.conf
│   ├── enabled_vhosts
│   │   ├── README
│   │   └── default.vhost -> ../available_vhosts/default.vhost
│   └── rewrites
│   │   ├── default_rewrite.rules
│   │   └── rewrite.rules
│   └── variables
|       ├── custom.vars
│       └── global.vars
└── conf.dispatcher.d
    ├── available_farms
    │   └── default.farm
    ├── cache
    │   ├── default_invalidate.any
    │   ├── default_rules.any
    │   ├── marketing_query_parameters.any
    │   └── rules.any
    ├── clientheaders
    │   ├── clientheaders.any
    │   └── default_clientheaders.any
    ├── dispatcher.any
    ├── enabled_farms
    │   ├── README
    │   └── default.farm -> ../available_farms/default.farm
    ├── filters
    │   ├── default_filters.any
    │   └── filters.any
    ├── renders
    │   └── default_renders.any
    └── virtualhosts
        ├── default_virtualhosts.any
        └── virtualhosts.any

Nedan visas en förklaring av anteckningsfiler som kan ändras:

Anpassningsbara filer

Följande filer kan anpassas och överförs till din molninstans vid distributionen:

Du kan ha en eller flera av dessa filer. De innehåller <VirtualHost> poster som matchar värdnamn och tillåter Apache att hantera varje domäntrafik med olika regler. Filerna skapas i katalogen available_vhosts och aktiveras med en symbolisk länk i katalogen enabled_vhosts. Från filerna .vhost inkluderas andra filer, som omskrivningar och variabler.

Den här filen inkluderas från dina .vhost-filer. Den har en uppsättning omskrivningsregler för mod_rewrite.

Den här filen inkluderas från dina .vhost-filer. Du kan lägga till definitioner för Apache-variabler på den här platsen.

Den här filen inkluderas från filen dispatcher_vhost.conf. Du kan ändra din Dispatcher och skriva om loggnivån i den här filen.

Du kan ha en eller flera av de här filerna och de innehåller grupper som matchar värdnamnen, och Dispatcher-modulen kan hantera varje grupp med olika regler. Filerna skapas i katalogen available_farms och aktiveras med en symbolisk länk i katalogen enabled_farms. Från filerna .farm ingår andra filer, till exempel filter, cacheregler och andra.

Den här filen inkluderas från dina .farm-filer. Den anger cachelagringsinställningar.

Den här filen inkluderas från dina .farm-filer. Den anger vilka begärandehuvuden som ska vidarebefordras till serverdelen.

Den här filen inkluderas från dina .farm-filer. Den har en uppsättning regler som ändrar vilken trafik som ska filtreras bort och inte hamna i bakgrunden.

Den här filen inkluderas från dina .farm-filer. Den har en lista med värdnamn eller URI-sökvägar som ska matchas med matchning av glob. Denna matchning avgör vilken serverdel som ska användas för att hantera en begäran.

Ovanstående filer refererar till de oföränderliga konfigurationsfiler som listas nedan. Ändringar av oföränderliga filer bearbetas inte av Dispatcher i molnmiljöer.

Oändringsbara konfigurationsfiler

Dessa filer ingår i grundramverket och följer standarder och bästa praxis. Filerna anses oföränderliga eftersom ändringar eller borttagningar lokalt inte påverkar distributionen eftersom de inte överförs till din molninstans.

Vi rekommenderar att ovanstående filer refererar till de oföränderliga filer som listas nedan, följt av eventuella ytterligare programsatser eller åsidosättningar. När Dispatcher-konfigurationen distribueras till en molnmiljö används den senaste versionen av de oföränderliga filerna, oavsett vilken version som användes i den lokala utvecklingen.

Innehåller ett exempel på en virtuell värd. Skapa en kopia av den här filen för din egen virtuella värd, anpassa den, gå till conf.d/enabled_vhosts och skapa en symbolisk länk till din anpassade kopia.

En del av basramverket, som används för att illustrera hur dina virtuella värdar och globala variabler inkluderas.

Standardregler för omskrivning som är lämpliga för ett standardprojekt. Redigera rewrite.rules om du behöver anpassa. När du anpassar kan du fortfarande inkludera standardreglerna först, om de passar dina behov.

Innehåller ett exempel på en Dispatcher-servergrupp. Skapa en kopia av den här filen för din egen servergrupp, anpassa den, gå till conf.d/enabled_farms och skapa en symbolisk länk till din anpassade kopia.

En del av basramverket genereras vid start. Du måste inkludera den här filen i alla grupper som du definierar i avsnittet cache/allowedClients.

Standardcacheregler som är lämpliga för ett standardprojekt. Ändra conf.dispatcher.d/cache/rules.any om du behöver anpassa. När du anpassar kan du fortfarande inkludera standardreglerna först, om de passar dina behov.

Standardbegäranrubriker som ska vidarebefordras till serverdelen, lämpliga för ett standardprojekt. Ändra clientheaders.any om du behöver anpassa. När du anpassar kan du fortfarande inkludera standardrubrikerna för begäran först, om de passar dina behov.

En del av det grundläggande ramverket, som används för att illustrera hur era Dispatcher gårdar ingår.

Standardfilter som passar för ett standardprojekt. Ändra filters.any om du behöver anpassa. När du anpassar kan du fortfarande inkludera standardfiltren först, om de passar dina behov.

Den här filen genereras vid start och ingår i det grundläggande ramverket. Du måste inkludera den här filen i alla grupper som du definierar i avsnittet renders.

Standardvärdglobbning som passar för ett standardprojekt. Ändra virtualhosts.any om du behöver anpassa. När du anpassar bör du inte ta med standardvärddatorns ordlista, eftersom den matchar varje inkommande begäran.

Apache-moduler som stöds apache-modules

Se Apache-moduler som stöds.

Lokal validering local-validation-legacy-mode

Använd skriptet validate.sh så som visas nedan:

$ validate.sh src/dispatcher
Phase 1: Dispatcher validator
Cloud manager validator 2.0.32
Phase 1 finished
Phase 2: httpd -t validation in docker image
values.csv found in deployment folder: /tmp/dispatcher_validation_1625150390 - using files listed there
Running script /docker_entrypoint.d/10-check-environment.sh
Running script /docker_entrypoint.d/20-create-docroots.sh
Running script /docker_entrypoint.d/30-wait-for-backend.sh
Waiting until localhost is available
localhost resolves to ::1
Running script /docker_entrypoint.d/40-generate-allowed-clients.sh
Running script /docker_entrypoint.d/50-check-expiration.sh
Running script /docker_entrypoint.d/60-check-loglevel.sh
Running script /docker_entrypoint.d/70-check-forwarded-host-secret.sh
# Dispatcher configuration: (/etc/httpd/conf.dispatcher.d/dispatcher.any)
/farms {

...

}
Syntax OK
Phase 2 finished
Phase 3: Immutability check
reading immutable file list from /etc/httpd/immutable.files.txt

...

no immutable file has been changed - check is SUCCESSFUL
Phase 3 finished

Skriptet gör följande:

Under en Cloud Manager-distribution körs även syntaxkontrollen httpd -t och eventuella fel inkluderas i Cloud Manager Build Images step failure-loggen.

Fas 1 first-phase

Om ett direktiv inte är tillåtslista loggas ett fel och en avslutningskod som inte är noll returneras. Dessutom genomsöks alla filer med mönstret conf.dispatcher.d/enabled_farms/*.farm och följande kontrolleras:

Valideringsverktyget rapporterar endast förbjuden användning av Apache-direktiv som inte har tillåtslista. Den rapporterar inte syntaktiska eller semantiska problem med din Apache-konfiguration eftersom den här informationen endast är tillgänglig för Apache-moduler i en körningsmiljö.

Nedan visas felsökningstekniker för felsökning av vanliga valideringsfel som genereras av verktyget:

Det går inte att hitta en conf.dispatcher.d-undermapp i arkivet

Arkivet bör innehålla mapparna conf.d och conf.dispatcher.d. Observera att du inte bör
använda prefixet etc/httpd i arkivet.

Det går inte att hitta någon servergrupp iconf.dispatcher.d/enabled_farms

De aktiverade grupperna bör finnas i den angivna undermappen.

Filen som ingår (…) måste ha namnet: …

Det finns två avsnitt i gruppkonfigurationen som måste innehålla en
specifik fil: /renders och /allowedClients i avsnittet /cache . Dessa
-avsnitten ska se ut så här:

/renders {
    $include "../renders/default_renders.any"
}

Och:

/allowedClients {
    $include "../cache/default_invalidate.any"
}

Filen finns på en okänd plats: …

Det finns fyra avsnitt i servergruppskonfigurationen där du kan inkludera din egen fil: /clientheaders, filters, /rules i /cache-avsnittet och /virtualhosts. De inkluderade filerna måste ha följande namn:

Du kan också inkludera standardversionen av de filerna, vars namn föregås av ordet default_, till exempel ../filters/default_filters.any.

Inkludera programsats på (…), utanför en känd plats: …

Förutom de sex avsnitt som nämns i styckena ovan är du inte tillåten
Om du till exempel vill använda programsatsen $include skulle följande generera det här felet:

/invalidate {
    $include "../cache/invalidate.any"
}

Tillåtna klienter/återgivningar inkluderas inte från: …

Det här felet genereras när du inte anger något inkluderingsfält för /renders och /allowedClients i avsnittet /cache. Se
filen som ingår (…) måste ha namnet: … för mer information.

Filtret får inte använda glob-mönster för att tillåta begäranden

Det är inte säkert att tillåta begäranden med en formatregel /glob, som matchas mot den fullständiga förfrågningsraden, till exempel

/0100 {
    /type "allow" /glob "GET *.css *"
}

Den här satsen är avsedd att tillåta begäranden för css filer, men tillåter även begäranden till any-resurser följt av frågesträngen ?a=.css. Det är därför förbjudet att använda sådana filter (se även CVE-2016-0957).

Den inkluderade filen (…) matchar inte någon känd fil

Det finns två typer av filer i din virtuella värdkonfiguration för Apache som kan anges som inkluderar: omskrivningar och variabler.
De inkluderade filerna måste ha följande namn:

Du kan också inkludera standardversionen av reglerna för omskrivning, vars namn är conf.d/rewrites/default_rewrite.rules.
Observera att det inte finns någon standardversion av variabelfilerna.

Inaktuell konfigurationslayout har identifierats, kompatibilitetsläge aktiveras

Det här meddelandet anger att din konfiguration har den föråldrade layouten version 1 som innehåller en fullständig
Apache-konfiguration och filer med ams_ prefix. Den här konfigurationen stöds fortfarande bakåt
bör du växla till den nya layouten.

Den första fasen kan också köras separat i stället för omslutningsskriptet validate.sh.

När den körs mot din maven-artefakt eller din dispatcher/src-underkatalog rapporterar den verifieringsfel:

$ validator full dispatcher/src
Cloud manager validator 1.0.4
2019/06/19 15:41:37 Apache configuration uses non-allowlisted directives:
  conf.d/enabled_vhosts/aem_publish.vhost:46: LogLevel
2019/06/19 15:41:37 Dispatcher configuration validation failed:
  conf.dispatcher.d/enabled_farms/999_ams_publish_farm.any: filter allows access to CRXDE

I Windows är Dispatcher-valideraren skiftlägeskänslig. Därför kan det misslyckas med att validera konfigurationen om du inte respekterar skiftläget för sökvägen där konfigurationen finns, till exempel:

bin\validator.exe full src
Cloud manager validator 2.0.xx
2021/03/15 18:15:40 Dispatcher configuration validation failed:
  conf.dispatcher.d\available_farms\default.farm:15: parent directory outside server root: c:\k\a\aem-dispatcher-sdk-windows-symlinks-testing3\dispatcher\src

Undvik det här felet genom att kopiera och klistra in sökvägen från Utforskaren i Windows och sedan i kommandotolken med ett cd-kommando i sökvägen.

Fas 2 second-phase

Den här fasen kontrollerar Apache-syntaxen genom att starta Docker i en bild. Docker måste installeras lokalt, men observera att AEM inte behöver köras.

Den här fasen kan också köras oberoende av validator full -d out src/dispatcher, vilket genererar en"out"-katalog som behövs för nästa kommando bin/docker_run.sh out host.docker.internal:4503 8080.

Under en Cloud Manager-distribution körs syntaxkontrollen httpd -t och eventuella fel tas med i Cloud Manager Build Images-loggen.

Fas 3 third-phase

Om ett fel uppstår i den här fasen betyder det att Adobe har ändrat en eller flera oföränderliga filer. I så fall måste du ersätta motsvarande oföränderliga filer med den nya versionen som levereras i katalogen src i SDK. Följande loggexempel visar detta problem:

Phase 3: Immutability check
reading immutable file list from /etc/httpd/immutable.files.txt
(...)
checking existing 'conf.dispatcher.d/clientheaders/default_clientheaders.any' for changes
immutable file 'conf.dispatcher.d/clientheaders/default_clientheaders.any' has been changed:
--- /etc/httpd/conf.dispatcher.d/clientheaders/default_clientheaders.any
+++ /etc/httpd-actual/conf.dispatcher.d/clientheaders/default_clientheaders.any
@@ -40,4 +40,3 @@
"Sling-uploadmode"
"x-requested-with"
"If-Modified-Since"
-"Authorization"
** error: immutable file 'conf.dispatcher.d/clientheaders/default_clientheaders.any' has been changed!

Den här fasen kan också köras oberoende av varandra via validator full -d out src/dispatcher, som genererar en out-katalog som behövs för nästa kommando bin/docker_immutability_check.sh out.

Felsöka Apache- och Dispatcher-konfigurationen debugging-apache-and-dispatcher-configuration

Du kan köra Apache Dispatcher lokalt med ./bin/docker_run.sh out docker.for.mac.localhost:4503 8080.

Som tidigare nämnts måste Docker installeras lokalt och det är inte nödvändigt att AEM körs. Windows-användare måste använda Windows 10 Professional eller andra distributioner som stöder Docker. Den här förutsättningen är nödvändig för att köra och felsöka Dispatcher på en lokal dator.

Följande strategi kan användas för att öka loggutdata för Dispatcher-modulen och för att se resultaten av utvärderingen av RewriteRule i både lokala miljöer och molnmiljöer.

Loggnivåer för de modulerna definieras av variablerna DISP_LOG_LEVEL och REWRITE_LOG_LEVEL. De kan anges i filen conf.d/variables/global.vars. Den relevanta delen är följande:

# Log level for the dispatcher
#
# Possible values are: error, warn, info, debug and trace1
# Default value: warn
#
# Define DISP_LOG_LEVEL warn

# Log level for mod_rewrite
#
# Possible values are: error, warn, info, debug and trace1 - trace8
# Default value: warn
#
# To debug your RewriteRules, it is recommended to raise your log
# level to trace2.
#
# More information can be found at:
# https://httpd.apache.org/docs/current/mod/mod_rewrite.html#logging
#
# Define REWRITE_LOG_LEVEL warn

När du kör Dispatcher lokalt skrivs loggar ut direkt till slututdata. Oftast vill du att de här loggarna ska vara i felsökningsversionen, vilket du kan göra genom att skicka felsökningsnivån som en parameter när du kör Docker. Till exempel: DISP_LOG_LEVEL=Debug ./bin/docker_run.sh out docker.for.mac.localhost:4503 8080.

Loggar för molnmiljöer visas via loggningstjänsten i Cloud Manager.

Olika Dispatcher-konfigurationer per miljö different-dispatcher-configurations-per-environment

För närvarande används samma Dispatcher-konfiguration för alla miljöer i AEM as a Cloud Service. Körningsmiljön har en miljövariabel ENVIRONMENT_TYPE som innehåller det aktuella körningsläget (dev, stage eller prod) och en definition. Definitionen kan vara ENVIRONMENT_DEV, ENVIRONMENT_STAGE eller ENVIRONMENT_PROD. I Apache-konfigurationen kan variabeln användas direkt i ett uttryck. Definitionen kan också användas för att skapa logik:

# Simple usage of the environment variable
ServerName ${ENVIRONMENT_TYPE}.company.com

# When more logic is required
<IfDefine ENVIRONMENT_STAGE>
  # These statements are for stage
  Define VIRTUALHOST stage.example.com
</IfDefine>
<IfDefine ENVIRONMENT_PROD>
  # These statements are for production
  Define VIRTUALHOST prod.example.com
</IfDefine>

I Dispatcher-konfigurationen är samma systemvariabel tillgänglig. Om mer logik krävs definierar du variablerna enligt exemplet ovan och använder dem sedan i konfigurationsavsnittet för Dispatcher:

/virtualhosts {
  { "${VIRTUALHOST}" }
}

När du testar konfigurationen lokalt kan du simulera olika miljötyper genom att skicka variabeln DISP_RUN_MODE till skriptet docker_run.sh direkt:

$ DISP_RUN_MODE=stage docker_run.sh out docker.for.mac.localhost:4503 8080

Standardkörningsläget när inget värde för DISP_RUN_MODE skickas är "dev".
Kör skriptet docker_run.sh utan argument om du vill ha en fullständig lista över tillgängliga alternativ och variabler.

Visa den Dispatcher-konfiguration som används av Docker-behållaren viewing-dispatcher-configuration-in-use-by-docker-container

Med miljöspecifika konfigurationer kan det vara svårt att avgöra hur Dispatcher-konfigurationen ser ut. När du har startat din Docker-behållare med docker_run.sh kan den dumpas enligt följande:

$ docker ps
CONTAINER ID       IMAGE
d75fbd23b29        adobe/aem-ethos/dispatcher-publish:...

$ docker exec d75fbd23b29 httpd-test
# Dispatcher configuration: (/etc/httpd/conf.dispatcher.d/dispatcher.any)
/farms {
  /publishfarm {
    /clientheaders {
...

Migrera från äldre läge till flexibelt läge migrating-flexible

Med Cloud Manager 2021.7.0 genererar nya Cloud Manager-program maven-projektstrukturer med AEM 28 eller senare, som innehåller filen opt-in/USE_SOURCES_DIRECTLY. Tidigare begränsningar för det äldre läget runt antalet filer och filstorleken tas bort, vilket även gör att SDK och miljön validerar och distribuerar konfigurationen på ett förbättrat sätt. Om din Dispatcher-konfiguration inte har den här filen rekommenderar vi att du migrerar. Använd de metoder som beskrivs på sidan Flexibelt läge.