Servlet to change logging levels.

GoogleCodeExporter commented 8 years ago

It would be convenient for support engineers to be able to change the logging 
levels for the 
connector logs and the feed logs from the GSA via a servlet interface to the 
connector manager.

This would allow the support engineer to turn on more verbose logging, collect 
information, fetch 
the logs, then turn the verbosity back down.

It would also be convenient to remove existing log files.  For instance, if 
FeedLog level get set to 
OFF, delete any existing feed log.

Original issue reported on code.google.com by Brett.Mi...@gmail.com on 28 Jul 2008 at 7:16

GoogleCodeExporter commented 8 years ago

Original comment by jeffreyl...@gmail.com on 28 Jul 2008 at 7:24

Added labels: Priority-High
Removed labels: Priority-Low

GoogleCodeExporter commented 8 years ago

This feature was postponed until after the GData-based configuration redesign.

Original comment by Brett.Mi...@gmail.com on 7 Nov 2008 at 12:47

Changed state: WontFix

GoogleCodeExporter commented 8 years ago

Original comment by jl1615@gmail.com on 8 Dec 2008 at 9:17

Changed state: Accepted

GoogleCodeExporter commented 8 years ago

Original comment by jl1615@gmail.com on 9 Dec 2008 at 1:33

Added labels: Priority-Medium
Removed labels: Priority-High

GoogleCodeExporter commented 8 years ago

Original comment by mgron...@gmail.com on 6 May 2009 at 10:04

Added labels: Milestone-Goal_2.4.0

GoogleCodeExporter commented 8 years ago

Original comment by jl1615@gmail.com on 18 Sep 2009 at 8:35

Removed labels: Milestone-Goal_2.4.0

GoogleCodeExporter commented 8 years ago

Original comment by jl1615@gmail.com on 19 Sep 2009 at 3:58

Added labels: Milestone-Goal_2.4.0

GoogleCodeExporter commented 8 years ago

Original comment by mar...@google.com on 4 Dec 2009 at 11:01

Removed labels: Milestone-Goal_2.4.0

GoogleCodeExporter commented 8 years ago

Original comment by Brett.Mi...@gmail.com on 5 Apr 2011 at 1:33

Changed state: CodeReview

GoogleCodeExporter commented 8 years ago

How to interact with Connectors from inside the appliance

Test Connectivity 
Get Connector List 
Get Connector Instance List 
Restart Traversal
Change Logging Levels
Get Logs
Get Configuration Files 

Test Connectivity

Test that the Connector Manager Web application is running.
Returns the Connector Manager version. This is useful for
determining that the correct Connector Manager is configured.

Usage:
------
To test connectivity with the Connector:
 http://[cm_host_addr]/connector-manager/testConnectivity

Returns the Connector Manager version, JVM version, OS version.

Get Connector List

Retrieve the list of installed Connector types, including
the Connector version.

Usage:
------
To test connectivity with the Connector:
 http://[cm_host_addr]/connector-manager/getConnectorList

Get Connector Instance List

Retrieve the list of Connector Instances, including
the connector name, connector type, connector version,
and connector schedule.  Useful for verifying the correct
connector version and fetching the correct connector name.

Usage:
------
To test connectivity with the Connector:
 http://[cm_host_addr]/connector-manager/getConnectorInstanceList

Restart Traversal

Start traversing the ECM repository from the logical
beginning. Very useful after changes to the connector
configuration would result in different set of documents
being fed.

Usage:
-----

To restart the indexing traversal for a Connector:
 http://[cm_host_addr]/connector-manager/restartConnectorTraversal?ConnectorName=[connector_name]
where [connector_name] is the name of a connector instance.

Change Logging Levels  (Connector Manager v2.8 and later)

Admin servlet to set and fetch the logging Level for the
Connector Manager's Connector logs or Feed logs.

This servlet allows the user to alter the level of logging detail
dynamically, without restarting the Connector Manager.  More detailed
logs are especially useful when trying to troubleshoot connector problems.

Connector logs contain the status of the Connector Manager and all
Connector instances as they perform their various tasks.
Feed logs identify each document, and it associated meta-data, as
they are feed to the GSA.

The recognized logging levels in increasing levels of detail are:
SEVERE - Catastrophic failure; the Connector cannot continue
    running.                                                          
WARNING - Unexpected exceptional conditions, the product may
    not function properly.                                                
INFO - Informational message. This is the default connector
    logging level upon installation.
CONFIG - Configuration details and higher product functions.
FINE - Generally information related to batches of documents.
FINER - Generally information related individual documents.
FINEST - Generally information related to document meta-data,
    processing detail that is exceptionally verbose.

In addition to the above logging levels, the following psuedo-levels
are recognized:
OFF - Logging is turned off.  This is the default feed logging
    level upon installation.
ALL - Enable most detailed logging (alias of FINEST).

ALL and OFF are more conveniently used with feed logging,
which is currently an "all or nothing" style implementation.

After altering the desired logging level, allow the product to run for
the prescribed time (anywhere from several minutes to days).  Then the
getConnectorLogs or getFeedLogs commands (below) may be used to fetch
the accumulated log files for analysis.

Usage:
------

To fetch the current connector logging level:
 http://[cm_host_addr]/connector-manager/getConnectorLogLevel

To set the connector logging level:
 http://[cm_host_addr]/connector-manager/setConnectorLogLevel?level=[level] 

where [level] is one of the previously defined logging levels.  
Setting the connector logging level to INFO restores it to the
default configuration.  Setting the connector logging level to
OFF is not recommended.

For instance:
 http://[cm_host_addr]/connector-manager/setConnectorLogLevel?level=ALL

To fetch the current feed logging level:
 http://[cm_host_addr]/connector-manager/getFeedLogLevel

To set the feed logging level:
 http://[cm_host_addr]/connector-manager/setFeedLogLevel?level=[level]

where [level] is one of the previously defined logging levels.  
For feed logs, the recommended levels are OFF and ALL.     

For instance:                                                                   

 http://[cm_host_addr]/connector-manager/setFeedLogLevel?level=ALL

Original comment by Brett.Mi...@gmail.com on 13 Apr 2011 at 12:30

GoogleCodeExporter commented 8 years ago

Fixed 12 April 2011 as Connector Manager revision r2718

Original comment by Brett.Mi...@gmail.com on 13 Apr 2011 at 12:31

Changed state: Fixed

GoogleCodeExporter commented 8 years ago

Original comment by Brett.Mi...@gmail.com on 26 Apr 2011 at 9:18

Added labels: Milestone-Release_2.8.0

PILLUTLAAVINASH / google-enterprise-connector-manager

Servlet to change logging levels. #104