Partager via


Fichiers journaux FTP <logFile>

Vue d’ensemble

L’élément <logFile> est utilisé pour configurer les options de journalisation d’activité d’un site FTP.

Par exemple, vous pouvez activer ou désactiver la journalisation, spécifier les catégories d’informations à stocker dans le fichier journal et modifier le répertoire dans lequel le fichier journal est stocké. Vous pouvez également utiliser l’élément <logFile> pour contrôler la fréquence à laquelle IIS crée un fichier journal en fonction de la taille ou de l’intervalle de temps du fichier journal et de la taille maximale (en octets) qu’un fichier journal peut devenir.

Remarque

Contrairement aux sites Web qui peuvent utiliser le format IIS, NCSA ou W3C pour les fichiers journaux, le service FTP 7 stocke uniquement les fichiers journaux au format W3C.

Vous pouvez définir les catégories d’informations que IIS journalise en modifiant l’attribut logExtFileFlags. Les valeurs par défaut sont Date, Time, ClientIP, UserName, ServerIP, Method, UriStem, FtpStatus, Win32Status, FtpSubStatus, ServerPort, Session et FullPath.

Compatibilité

Version Notes
IIS 10.0 L’élément <logFile> n’a fait l’objet d’aucune modification dans IIS 10.0.
IIS 8.5 L’élément <logFile> n’a fait l’objet d’aucune modification dans IIS 8.5.
IIS 8.0 L’élément <logFile> n’a fait l’objet d’aucune modification dans IIS 8.0.
IIS 7.5 L’élément <logFile> de l’élément <ftpServer> est fourni en tant que fonctionnalité d’IIS 7.5.
IIS 7.0 L’élément <logFile> de l’élément <ftpServer> a été introduit dans FTP 7.0, qui était un téléchargement distinct pour IIS 7.0.
IIS 6.0 N/A

Remarque

Les services FTP 7.0 et FTP 7.5 ont été expédiés hors bande pour IIS 7.0, ce qui nécessite le téléchargement et l’installation du service à partir de l’URL suivante :

https://www.iis.net/expand/FTP

Avec Windows 7 et Windows Server 2008 R2, le service FTP 7.5 est fourni en tant que fonctionnalité pour IIS 7.5. Le téléchargement du service FTP n’est donc plus nécessaire.

Programme d’installation

Pour prendre en charge la publication FTP pour votre serveur web, vous devez installer le service FTP. Pour cela, procédez comme suit.

Windows Server 2012 ou Windows Server 2012 R2

  1. Dans la barre des tâches, cliquez sur Gestionnaire de serveur.

  2. Dans Gestionnaire de serveur, cliquez sur le menu Gérer puis sur Ajouter des rôles et des fonctionnalités.

  3. Dans l’Assistant Ajout de rôles et de fonctionnalités, cliquez sur Suivant. Sélectionnez le type d’installation, puis cliquez sur Suivant. Sélectionnez le serveur de destination, puis cliquez sur Suivant.

  4. Sur la page Serveur des rôles, développez Serveur internet (IIS)puis sélectionnez Serveur FTP.

    Remarque

    Pour prendre en charge l’authentification d’appartenance ASP ou l’authentification du Gestionnaire IIS pour le service FTP, vous devez sélectionner l’extensibilitéFTP, en plus du service FTP.
    Screenshot of the F T P Extensibility option being highlighted. .

  5. Cliquez sur Suivant, puis, dans la page Sélectionner des fonctionnalités, cliquez à nouveau sur Suivant.

  6. Dans la page Confirmer les sélections d’installation, cliquez sur Installer.

  7. Dans la page Résultats , cliquez sur Fermer.

Windows 8 ou Windows 8.1

  1. Dans l’écran d’accueil, déplacez le pointeur jusqu’au coin inférieur gauche, cliquez avec le bouton droit sur le bouton Démarrer, puis cliquez sur Panneau de configuration.

  2. Dans Panneau de configuration, cliquez sur Programmes et fonctionnalités, puis sur Activer ou désactiver des fonctionnalités Windows.

  3. Développez Internet Information Services, puis sélectionnez Serveur FTP.

    Remarque

    Pour prendre en charge l’authentification d’appartenance ASP ou du Gestionnaire IIS pour le service FTP, vous devez également sélectionner l’extensibilité FTP.
    Screenshot of the F T P Extensibility folder being highlighted.

  4. Cliquez sur OK.

  5. Cliquez sur Fermer.

Windows Server 2008 R2

  1. Dans la barre des tâches, cliquez sur Démarrer, pointez sur Outils d’administration, puis cliquez sur Gestionnaire de serveur.

  2. Dans le volet hiérarchie du Gestionnaire de serveur, développez Rôles, puis cliquez sur Serveur web (IIS).

  3. Dans le volet Serveur web (IIS), faites défiler jusqu’à la section Services de rôle, puis cliquez sur Ajouter des services de rôle.

  4. Dans la page Sélectionner des services de rôle de l’Assistant Ajouter des services de rôle, développez le Serveur FTP.

  5. Sélectionnez Service FTP.

    Remarque

    Pour prendre en charge l’authentification d’appartenance ASP ou du Gestionnaire IIS pour le service FTP, vous devez également sélectionner l’extensibilité FTP.
    Screenshot of the F T P Service option being highlighted.

  6. Sélectionnez Suivant.

  7. Dans la page Confirmer les sélections pour l'installation, cliquez sur Installer.

  8. Dans la page Résultats , cliquez sur Fermer.

Windows 7

  1. Dans la barre des tâches, cliquez sur Démarrer, puis sur Panneau de configuration.

  2. Dans le Panneau de configuration, cliquez sur Programmes et fonctionnalités, puis sur Activer ou désactiver des fonctionnalités Windows.

  3. Développez Internet Information Services puis Serveur FTP.

  4. Sélectionnez Service FTP.

    Remarque

    Pour prendre en charge l’authentification d’appartenance ASP ou du Gestionnaire IIS pour le service FTP, vous devez également sélectionner l’extensibilité FTP.
    Screenshot of the Internet Information Services folder's sub folders.

  5. Cliquez sur OK.

Windows Vista ou Windows Server 2008

  1. Téléchargez le package d’installation à partir de l’URL suivante :

  2. Suivez les instructions de la procédure pas à pas suivante pour installer le service FTP :

Procédure

Guide pratique pour configurer des options de journalisation pour un site FTP

  1. Ouvrez le Gestionnaire des services Internet (IIS) :

    • Si vous utilisez Windows Server 2012 ou Windows Server 2012 R2 :

      • Dans la barre des tâches, cliquez sur Gestionnaire de serveur, cliquez sur Outils, puis sur Gestionnaire Internet Information Services (IIS).
    • Si vous utilisez Windows 8 ou Windows 8.1 :

      • Maintenez la touche Windows enfoncée, appuyez sur la lettre X, puis cliquez sur Panneau de configuration.
      • Cliquez sur Outils d'administration, puis double-cliquez sur Gestionnaire des services Internet (IIS).
    • Si vous utilisez Windows Server 2008 ou Windows Server 2008 R2 :

      • Cliquez sur Démarrer, placez le curseur sur Outils d'administration, puis cliquez sur Gestionnaire Internet Information Services (IIS).
    • Si vous utilisez Windows Vista ou Windows 7 :

      • Dans la barre des tâches, cliquez sur Démarrer, puis sur Panneau de configuration.
      • Double-cliquez sur Outils d'administration, puis double-cliquez sur Gestionnaire des services Internet (IIS).
  2. Dans le volet Connexions, développez le nom du serveur, puis accédez au site où vous souhaitez configurer la journalisation.

  3. Dans le volet Accueil, double-cliquez sur Journalisation FTP.
    Screenshot of the Home pane with the F T P Logging option being highlighted. Dans la section Substitution du fichier journal, cliquez sur Sélectionner les champs W3C...

  4. Sélectionnez les champs de vos fichiers journaux puis cliquez sur OK.
    Screenshot of the W 3 C Logging Fields dialog box, showing multiple fields to select.

  5. Sous Répertoire, spécifiez le chemin d'accès où le fichier journal doit être stocké. La valeur par défaut est %SystemDrive%\inetpub\logs\LogFiles.

  6. Dans la section substitution de fichier journal, spécifiez les options suivantes :

    • Planifier : pour créer un fichier journal basé sur l’une des valeurs suivantes :

      • Toutes les heures: un nouveau fichier journal est créé chaque heure.
      • Tous les jours: un nouveau fichier journal est créé chaque jour.
      • Toutes les semaines: un nouveau fichier journal est créé chaque semaine.
      • Tous les mois: un nouveau fichier journal est créé chaque mois.
    • Taille de fichier maximales (en octets) : pour créer un nouveau fichier journal lorsque le fichier atteint une certaine taille (en octets). La taille de fichier minimale est 1 048 576 octets. Si cet attribut a pour valeur un nombre inférieur à 1 048 576 octets, la valeur par défaut est implicitement 1 048 576 octets.

    • Ne créez pas de fichier journal : Il existe un fichier journal unique qui continuera à croître à mesure que les informations sont journalisées.

    • Sélectionnez Utiliser l’heure locale pour l’affectation de noms et la substitution de fichiers pour spécifier le nommage et l’heure de la substitution de fichier journal utilise l’heure du serveur local. Si cette option n’est pas sélectionnée, le temps universel coordonné (UTC) est utilisé.
      Screenshot of the Log File Rollover section, showing the Schedule and Maximum file size options.

  7. Cliquez sur Appliquer dans le volet Actions.

Configuration

Attributs

Attribut Description
directory Attribut de chaîne facultatif.

Spécifie le répertoire de journalisation, où sont stockés le fichier journal et les fichiers de prise en charge liés à la journalisation.

La valeur par défaut est %SystemDrive%\inetpub\logs\LogFiles.
enabled Attribut booléen facultatif.

true si la journalisation est activée ; sinon, false.

La valeur par défaut est true.
localTimeRollover Attribut booléen facultatif.

true si le nouveau fichier journal est créé en fonction de l’heure locale ; sinon, false pour le temps universel coordonné (UTC), qui était précédemment appelé Heure moyenne de Greenwich (GMT).

Remarque :  quel que soit le paramètre, l’horodatage de chaque enregistrement de journal de journalisation étendu W3C est basé sur UTC.

La valeur par défaut est false.
logExtFileFlags Attribut d’indicateurs facultatifs.

Spécifie les catégories d’informations écrites dans le fichier journal (lorsque vous utilisez le format de fichier journal étendu W3C) ou dans la source de données ODBC lors de la journalisation d’un site. L’attribut logExtFileFlags peut être une ou plusieurs des valeurs suivantes. Si vous spécifiez plusieurs valeurs, séparez-les par une virgule (,).

Les valeurs par défaut sont Date, Time, ClientIP, UserName, ServerIP, Method, UriStem, FtpStatus, Win32Status, FtpSubStatus, ServerPort, Session et FullPath.
Valeur Description
BytesRecv Enregistrer le nombre d’octets reçus par le serveur.

La valeur numérique est 8192.
BytesSent Enregistrer le nombre d’octets envoyés par le serveur.

La valeur numérique est 4096.
ClientIP Enregistrer l’adresse IP du client qui a effectué la demande.

La valeur numérique est 4.
ClientPort Enregistrer le port du client qui a effectué la demande.

La valeur numérique est 33554432.
ComputerName Enregistrer le nom du serveur sur lequel l’entrée du fichier journal a été générée.

La valeur numérique est 32.
Date Journaliser la date à laquelle l’activité s’est produite.

La valeur numérique est 1.
FtpStatus Journaliser le code d’état FTP.

La valeur numérique est 1024.
FtpSubStatus Journaliser le code de sous-état de l’erreur FTP.

La valeur numérique est 2097152.
FullPath Journaliser le chemin relatif complet. Remarque : Il peut s’agir d’un URI différent que le client a demandé, qui est journalisé en définissant l’indicateur UriStem.

La valeur numérique est 8388608.
Host Journaliser le nom d’hôte virtuel, s’il en existe un.

La valeur numérique est 1048576.
Info Journaliser les informations de débogage étendues, le cas échéant.

La valeur numérique est 16777216.
Method Action demandée. Par exemple, USER , PASS, etc.

La valeur numérique est 128.
ServerIP Enregistrer l’adresse IP du serveur sur lequel l’entrée du fichier journal a été générée.

La valeur numérique est 64.
ServerPort Enregistrer le numéro de port du serveur configuré pour le service.

La valeur numérique est 32768.
Session Journaliser l’identificateur unique de la session FTP. Cela est utile pour analyser l’activité de session dans vos journaux.

La valeur numérique est 4194304.
SiteName Journaliser le nom du service Internet et le numéro d’instance du site.

La valeur numérique est 16.
Time Journaliser l’heure en temps universel coordonné (UTC), à laquelle l’activité s’est produite.

La valeur numérique est 2.
TimeTaken Consigner la durée nécessaire à la fin d’une demande. Le temps nécessaire est enregistré en millisecondes.

La valeur numérique est 16384.
UriStem Consigner les informations de souche de l’URI (Universal Resource Identifier), qui est la cible de l’action. Remarque : Cela montre la vapeur d’URI exactement comme le client demandé, ce qui peut ne pas être le chemin relatif complet. Pour le chemin relatif complet, utilisez l’indicateur FullPath .

La valeur numérique est 256.
UserName Enregistrer le nom de l’utilisateur authentifié ayant accédé au serveur. Les utilisateurs anonymes sont indiqués par un trait d'union.

La valeur numérique est 8.
Win32Status Enregistrer le code d’état Windows.

La valeur numérique est 2048.
period Attribut d’énumération facultatif.

Spécifie la fréquence à laquelle le service FTP crée un fichier journal. L’attribut period peut être l’une des valeurs possibles suivantes.

La valeur par défaut est Daily.
Valeur Description
Daily Créer un fichier journal.

La valeur numérique est 1.
Hourly Créer un nouveau fichier journal.

La valeur numérique est 4.
MaxSize Créer un fichier journal lorsqu’une taille maximale est atteinte. La taille maximale est spécifiée dans l’attribut truncateSize.

La valeur numérique est 0.
Monthly Créer un fichier journal mensuel.

La valeur numérique est 3.
Weekly Crée un nouveau fichier journal toutes les semaines.

La valeur numérique est 2.
selectiveLogging Attribut d’indicateurs facultatifs.

Spécifie la détail de la journalisation FTP.

La valeur par défaut est LogSuccessful,LogError,LogInfrastructure.
Valeur Description
LogError Spécifie que les erreurs doivent être enregistrées. La quantité de données réellement journalisées dépend également du paramètre d’indicateur LogInfrastructure.

La valeur numérique est 2.
LogInfrastructure Spécifie que toutes les commandes FTP et l’activité du canal de données de bas niveau seront journalisées. Par exemple, les journaux contiennent des entrées pour DataChannelOpened, DataChannelClosed, PORT/EPRT, PASV/EPSV, si l’indicateur LogInfrastructure est défini.

La valeur numérique est 4.
LogSuccessful Spécifie que l’activité réussie sera journalisée. La quantité de données réellement journalisées dépend également du paramètre d’indicateur LogInfrastructure.

La valeur numérique est 1.
truncateSize Attribut int64 facultatif.

Spécifie la taille maximale du fichier journal (en octets) après laquelle créer un fichier journal. Cette valeur s’applique uniquement lorsque MaxSize est choisi pour l’attribut period. La taille minimale du fichier est de 1 048 576 octets. Si cet attribut a pour valeur un nombre inférieur à 1 048 576 octets, la valeur par défaut est implicitement 1 048 576 octets.

La valeur par défaut est 20971520.

Éléments enfants

Aucune.

Exemple Configuration

L’exemple de configuration suivant montre un FTP avec des options de journalisation personnalisées qui spécifient que les commandes d’infrastructure ne seront pas journalisées, les fichiers journaux seront pivotés quotidiennement et l’option de débogage supplémentaire a été ajoutée aux champs par défaut.

<site name="ftp.example.com" id="5">
   <application path="/">
      <virtualDirectory path="/" physicalPath="c:\inetpub\www.example.com" />
   </application>
   <bindings>
      <binding protocol="ftp" bindingInformation="*:21:" />
   </bindings>
   <ftpServer serverAutoStart="true">
      <security>
          <authentication>
            <basicAuthentication enabled="true" />
            <anonymousAuthentication enabled="false" />
          </authentication>
      </security>
      <logFile period="Daily"
         logExtFileFlags="Date, Time, ClientIP, UserName, ServerIP, Method, UriStem, FtpStatus, Win32Status, ServerPort, FtpSubStatus, Session, FullPath, Info"
         selectiveLogging="LogSuccessful, LogError" />
   </ftpServer>
</site>

Exemple de code

Les exemples suivants illustrent l’activation de la journalisation pour un site FTP, la configuration du répertoire de fichiers journaux pour un site FTP pour un chemin spécifique et la spécification du recyclage quotidien des fichiers journaux.

AppCmd.exe

appcmd.exe set config -section:system.applicationHost/sites /[name='ftp.example.com'].ftpServer.logFile.directory:"C:\logs\LogFiles" /commit:apphost

appcmd.exe set config -section:system.applicationHost/sites /[name='ftp.example.com'].ftpServer.logFile.period:"Daily" /commit:apphost

appcmd.exe set config -section:system.applicationHost/sites /[name='ftp.example.com'].ftpServer.logFile.enabled:"True" /commit:apphost

Remarque

Vous devez veiller à définir le paramètre commit sur apphost quand vous utilisez AppCmd.exe pour configurer ces paramètres. Cela valide les paramètres de configuration dans la section d’emplacement appropriée dans le fichier ApplicationHost.config.

C#

using System;
using System.Text;
using Microsoft.Web.Administration;

internal static class Sample
{
   private static void Main()
   {
      using (ServerManager serverManager = new ServerManager())
      {
         Configuration config = serverManager.GetApplicationHostConfiguration();
         ConfigurationSection sitesSection = config.GetSection("system.applicationHost/sites");
         ConfigurationElementCollection sitesCollection = sitesSection.GetCollection();

         ConfigurationElement siteElement = FindElement(sitesCollection, "site", "name", @"ftp.example.com");
         if (siteElement == null) throw new InvalidOperationException("Element not found!");

         ConfigurationElement ftpServerElement = siteElement.GetChildElement("ftpServer");
         ConfigurationElement logFileElement = ftpServerElement.GetChildElement("logFile");
         logFileElement["directory"] = @"C:\logs\LogFiles";
         logFileElement["period"] = @"Daily";
         logFileElement["enabled"] = true;

         serverManager.CommitChanges();
      }
   }

   private static ConfigurationElement FindElement(ConfigurationElementCollection collection, string elementTagName, params string[] keyValues)
   {
      foreach (ConfigurationElement element in collection)
      {
         if (String.Equals(element.ElementTagName, elementTagName, StringComparison.OrdinalIgnoreCase))
         {
            bool matches = true;
            for (int i = 0; i < keyValues.Length; i += 2)
            {
               object o = element.GetAttributeValue(keyValues[i]);
               string value = null;
               if (o != null)
               {
                  value = o.ToString();
               }
               if (!String.Equals(value, keyValues[i + 1], StringComparison.OrdinalIgnoreCase))
               {
                  matches = false;
                  break;
               }
            }
            if (matches)
            {
               return element;
            }
         }
      }
      return null;
   }
}

VB.NET

Imports System
Imports System.Text
Imports Microsoft.Web.Administration

Module Sample
   Sub Main()
      Dim serverManager As ServerManager = New ServerManager
      Dim config As Configuration = serverManager.GetApplicationHostConfiguration
      Dim sitesSection As ConfigurationSection = config.GetSection("system.applicationHost/sites")
      Dim sitesCollection As ConfigurationElementCollection = sitesSection.GetCollection
      Dim siteElement As ConfigurationElement = FindElement(sitesCollection, "site", "name", "ftp.example.com")

      If (siteElement Is Nothing) Then
         Throw New InvalidOperationException("Element not found!")
      End If

      Dim ftpServerElement As ConfigurationElement = siteElement.GetChildElement("ftpServer")
      Dim logFileElement As ConfigurationElement = ftpServerElement.GetChildElement("logFile")
      logFileElement("directory") = "C:\logs\LogFiles"
      logFileElement("period") = "Daily"
      logFileElement("enabled") = True

      serverManager.CommitChanges()
   End Sub

   Private Function FindElement(ByVal collection As ConfigurationElementCollection, ByVal elementTagName As String, ByVal ParamArray keyValues() As String) As ConfigurationElement
      For Each element As ConfigurationElement In collection
         If String.Equals(element.ElementTagName, elementTagName, StringComparison.OrdinalIgnoreCase) Then
            Dim matches As Boolean = True
            Dim i As Integer
            For i = 0 To keyValues.Length - 1 Step 2
               Dim o As Object = element.GetAttributeValue(keyValues(i))
               Dim value As String = Nothing
               If (Not (o) Is Nothing) Then
                  value = o.ToString
               End If
               If Not String.Equals(value, keyValues((i + 1)), StringComparison.OrdinalIgnoreCase) Then
                  matches = False
                  Exit For
               End If
            Next
            If matches Then
               Return element
            End If
         End If
      Next
      Return Nothing
   End Function


End Module

JavaScript

var adminManager = new ActiveXObject('Microsoft.ApplicationHost.WritableAdminManager');
adminManager.CommitPath = "MACHINE/WEBROOT/APPHOST";
var sitesSection = adminManager.GetAdminSection("system.applicationHost/sites", "MACHINE/WEBROOT/APPHOST");
var sitesCollection = sitesSection.Collection;
var siteElementPos = FindElement(sitesCollection, "site", ["name", "ftp.example.com"]);

if (siteElementPos == -1) throw "Element not found!";
var siteElement = sitesCollection.Item(siteElementPos);

var ftpServerElement = siteElement.ChildElements.Item("ftpServer");
var logFileElement = ftpServerElement.ChildElements.Item("logFile");
logFileElement.Properties.Item("directory").Value = "C:\\logs\\LogFiles";
logFileElement.Properties.Item("period").Value = "Daily";
logFileElement.Properties.Item("enabled").Value = true;

adminManager.CommitChanges();

function FindElement(collection, elementTagName, valuesToMatch) {
   for (var i = 0; i < collection.Count; i++) {
      var element = collection.Item(i);
      if (element.Name == elementTagName) {
         var matches = true;
         for (var iVal = 0; iVal < valuesToMatch.length; iVal += 2) {
            var property = element.GetPropertyByName(valuesToMatch[iVal]);
            var value = property.Value;
            if (value != null) {
               value = value.toString();
            }
            if (value != valuesToMatch[iVal + 1]) {
               matches = false;
               break;
            }
         }
         if (matches) {
            return i;
         }
      }
   }
   return -1;
}

VBScript

Set adminManager = createObject("Microsoft.ApplicationHost.WritableAdminManager")
adminManager.CommitPath = "MACHINE/WEBROOT/APPHOST"

Set sitesSection = adminManager.GetAdminSection("system.applicationHost/sites", "MACHINE/WEBROOT/APPHOST")
Set sitesCollection = sitesSection.Collection
siteElementPos = FindElement(sitesCollection, "site", Array("name", "ftp.example.com"))

If siteElementPos = -1 Then
Wscript.Echo "Element not found!"
WScript.Quit
End If

Set siteElement = sitesCollection.Item(siteElementPos)
Set ftpServerElement = siteElement.ChildElements.Item("ftpServer")
Set logFileElement = ftpServerElement.ChildElements.Item("logFile")
logFileElement.Properties.Item("directory").Value = "C:\logs\LogFiles"
logFileElement.Properties.Item("period").Value = "Daily"
logFileElement.Properties.Item("enabled").Value = true

adminManager.CommitChanges()

Function FindElement(collection, elementTagName, valuesToMatch)
   For i = 0 To CInt(collection.Count) - 1
      Set element = collection.Item(i)
      If element.Name = elementTagName Then
         matches = True
         For iVal = 0 To UBound(valuesToMatch) Step 2
            Set property = element.GetPropertyByName(valuesToMatch(iVal))
            value = property.Value
            If Not IsNull(value) Then
               value = CStr(value)
            End If
            If Not value = CStr(valuesToMatch(iVal + 1)) Then
               matches = False
               Exit For
            End If
         Next
         If matches Then
            Exit For
         End If
      End If
   Next
   If matches Then
      FindElement = i
   Else
      FindElement = -1
   End If
End Function