From 8053590db664b766c98f37467b78558647376f7a Mon Sep 17 00:00:00 2001 From: "Maria Odea B. Ching" Date: Mon, 27 Jul 2009 10:53:56 +0000 Subject: [PATCH] [MRM-1191] Add Archiva log files in documentation Submitted by: Jevica Arianne B. Zurbano o identified and defined what each log file is for additional modifications to the patch: o reworded description of archiva-audit.log and archiva.log git-svn-id: https://svn.apache.org/repos/asf/archiva/trunk@798099 13f79535-47bb-0310-9956-ffa450edef68 --- .../src/site/apt/adminguide/archiva-logs.apt | 37 +++++++++++++++++ .../src/site/apt/adminguide/audit-logs.apt | 2 +- .../src/site/apt/adminguide/logging.apt | 24 +++++++++++ .../src/site/apt/adminguide/security-logs.apt | 40 +++++++++++++++++++ archiva-docs/src/site/site.xml | 6 ++- 5 files changed, 107 insertions(+), 2 deletions(-) create mode 100644 archiva-docs/src/site/apt/adminguide/archiva-logs.apt create mode 100644 archiva-docs/src/site/apt/adminguide/logging.apt create mode 100644 archiva-docs/src/site/apt/adminguide/security-logs.apt diff --git a/archiva-docs/src/site/apt/adminguide/archiva-logs.apt b/archiva-docs/src/site/apt/adminguide/archiva-logs.apt new file mode 100644 index 000000000..d11c79890 --- /dev/null +++ b/archiva-docs/src/site/apt/adminguide/archiva-logs.apt @@ -0,0 +1,37 @@ + ------ + Archiva Logs + ------ + ------ + 22 Jul 2009 + ------ + +Archiva Logs + + Archiva's <<>> directory contains an archiva log file named <<>>, which logs all the startup information and the output logs of Archiva. + + A typical record looks like this: + +------ +2009-07-13 16:04:52,869 [WrapperSimpleAppMain] INFO org.apache.maven.archiva.security.ArchivaStandardRolesCheck - + Checking the existance of required roles. +2009-07-13 16:04:52,869 [WrapperSimpleAppMain] INFO org.apache.maven.archiva.security.ArchivaStandardRolesCheck - + Checking the existance of required operations. +2009-07-13 16:04:52,869 [WrapperSimpleAppMain] INFO org.apache.maven.archiva.web.startup.SecuritySynchronization - + Environment Check: required-roles -> 0 violation(s) +2009-07-13 16:04:53,371 [WrapperSimpleAppMain] INFO org.apache.maven.archiva.web.startup.Banner - _________________________ + __________________________________ + /\_ / \ + /`/@), | On behalf of all of the alpacas | + | (~' __| toiling away on the Apache Archiva | + _,--.___/ | \ project team, I would like to | + ,' , ( | \ welcome you to Archiva | + | ( \ / | 1.2.1 | + \ )\_/ ,_/ | | + / / ( |/ | http://archiva.apache.org/ | + ( | ( | | users@archiva.apache.org | + \| \| \__________________________________/ + + +2009-07-13 16:04:55,129 [WrapperSimpleAppMain] INFO org.codehaus.plexus.redback.struts2.interceptor.SecureActionInterceptor - + org.codehaus.plexus.redback.struts2.interceptor.SecureActionInterceptor initialized! +------ diff --git a/archiva-docs/src/site/apt/adminguide/audit-logs.apt b/archiva-docs/src/site/apt/adminguide/audit-logs.apt index 26d41d4d1..593d8ce8f 100644 --- a/archiva-docs/src/site/apt/adminguide/audit-logs.apt +++ b/archiva-docs/src/site/apt/adminguide/audit-logs.apt @@ -4,7 +4,7 @@ Audit Logs - Archiva's log directory contains an audit log file named <<>>, which tracks events that occur in the server. + Archiva's <<>> directory contains an audit log file named <<>>, which tracks events that occur in the server. A typical record looks like this: diff --git a/archiva-docs/src/site/apt/adminguide/logging.apt b/archiva-docs/src/site/apt/adminguide/logging.apt new file mode 100644 index 000000000..8d7ed0ce7 --- /dev/null +++ b/archiva-docs/src/site/apt/adminguide/logging.apt @@ -0,0 +1,24 @@ + ------ + Log Files + ------ + ------ + 22 Jul 2009 + ------ + +Log Files + + To keep track of the Archiva performance and problems, log files are created during runtime. + These files can be found in the <<>> directory. + + * {{{archiva-logs.html} <>}} - contains all the start-up information and output logs for Archiva + + * {{{audit-logs.html} <>}} - contains information regarding the operations performed against + the repositories and configurations being modified. A good example is when an artifact + is deployed to an Archiva repository. The operation will be logged in this file, + with the date and timestamp of when the operation occurred, the userId of who performed + the deployment, and the artifact that was deployed. + + * {{{security-logs.html} <>}} - contains information regarding Archiva's security. + For example, a successful login of a user or a user account is created. + + [] diff --git a/archiva-docs/src/site/apt/adminguide/security-logs.apt b/archiva-docs/src/site/apt/adminguide/security-logs.apt new file mode 100644 index 000000000..e0e9e25c4 --- /dev/null +++ b/archiva-docs/src/site/apt/adminguide/security-logs.apt @@ -0,0 +1,40 @@ + ------ + Security Logs + ------ + ------ + 22 Jul 2009 + ------ + +Security Logs + + Archiva's <<>> directory contains a security log file named <<>>, + which keeps track of all the security operations such as user creation/deletion, user role assignments, and user log in/out. + + A typical record looks like this: + +------ +2009-07-22 12:03:11 - - Successful Login for user admin +2009-07-22 12:05:03 - admin - User Created: archiva +2009-07-22 12:05:25 - admin - Role Assigned to user archiva: Global Repository Manager +2009-07-22 12:05:33 - admin - User Modified: archiva +------ + + The hyphen delimited records are: + + * date and time (server local time) + + * current user performing the operation + + * the operation performed + + [] + + Currently, the following events are logged: + + * user creation/modification/deletion + + * user log in/out + + * assigning roles to a user + + [] diff --git a/archiva-docs/src/site/site.xml b/archiva-docs/src/site/site.xml index d9acfc19f..b9a8f54b3 100644 --- a/archiva-docs/src/site/site.xml +++ b/archiva-docs/src/site/site.xml @@ -66,7 +66,11 @@ - + + + + + -- 2.39.5