net.bull.javamelody

Enum Parameter

java.lang.Object

java.lang.Enum<Parameter>

net.bull.javamelody.Parameter

All Implemented Interfaces:

Serializable, Comparable<Parameter>

public enum Parameter
extends Enum<Parameter>

Liste des paramètres, tous optionnels.

Author:

Emeric Vernat

Enum Constant Summary

Enum Constants

Enum Constant and Description
ADMIN_EMAILS Liste des adresses mails séparées par des virgules des destinataires pour l'envoi par mail de rapport de hebdomadaire (null par défaut).
ALLOWED_ADDR_PATTERN Expression régulière (null par défaut) pour restreindre l'accès au monitoring à certaines adresses IP.
ANALYTICS_ID Identifiant de suivi google analytics s'il y a lieu (désactivé par défaut).
AUTHORIZED_USERS List of authorized users for BASIC auth, when you do no want to use a realm and "security-constraint" in web.xml.
CONNECTIONS_STACK_TRACES_DISABLED true | false, true will disable opening stack-traces of jdbc connections (default: false).
CONTEXT_FACTORY_ENABLED Expérimental, ne pas utiliser.
CSRF_PROTECTION_ENABLED Active la protection contre CSRF (false par défaut).
CUSTOM_REPORTS Liste des noms de rapports personnalisés (null par défaut).
DATASOURCES Liste des datasources jdbc quand elles ne peuvent trouvées automatiquement dans JNDI (null par défaut).
DISABLED Désactive le monitoring (false par défaut).
DISPLAYED_COUNTERS Compteurs affichés: mettre "http,sql,error,log,ejb" pour afficher les ejb3 ou "http,sql,error,log,spring" pour afficher les beans spring ("http,sql,error,log" par défaut).
DNS_LOOKUPS_DISABLED true | false, true will return localhost/127.0.0.1 for hostname/hostaddress, false will attempt dns lookup for hostname (default: false).
EJB_TRANSFORM_PATTERN Expression régulière (null par défaut) pour transformer la description d'une méthode ejb3.
ERROR_TRANSFORM_PATTERN Expression régulière (null par défaut) pour transformer la description d'une erreur http.
GUICE_TRANSFORM_PATTERN Expression régulière (null par défaut) pour transformer la description d'une méthode guice.
GZIP_COMPRESSION_DISABLED Paramètre pour désactiver la compression des flux http ("false" par défaut).
HTTP_TRANSFORM_PATTERN Expression régulière (null par défaut) pour transformer la description de la requête http et pour supprimer des parties variables (identifiant d'objet par exemple) afin de permettre l'agrégation sur ces requêtes.
JAVAMELODY_SWING_URL URL http du fichier jar javamelody-swing (null par défaut : le fichier sera téléchargé depuis https://github.com/javamelody/javamelody selon la version).
JOB_TRANSFORM_PATTERN Expression régulière (null par défaut) pour transformer le nom d'un job.
JPA_TRANSFORM_PATTERN Expression régulière (null par défaut) pour transformer la description d'une requête jpa.
JSF_TRANSFORM_PATTERN Expression régulière (null par défaut) pour transformer la description d'une action JSF.
JSP_TRANSFORM_PATTERN Expression régulière (null par défaut) pour transformer le nom d'une page jsp.
LOCALE To fix the locale of the reports (default to null, ie locale is given by the language of the browser).
LOG Active le log des requêtes http au niveau INFO (false par défaut).
LOG_TRANSFORM_PATTERN Expression régulière (null par défaut) pour transformer la description d'un log.
LOGGER_CLASS Name of a class to use for JavaMelody logs (default: null for detection of Logback, Log4J or java.util.logging).
MAIL_PERIODS Liste des périodes d'envoi des mails séparées par des virgules pour l'envoi par mail de rapport de hebdomadaire.
MAIL_SESSION Nom JNDI de la session mail pour l'envoi par mail de rapport de hebdomadaire (null par défaut).
MONITORING_PATH URL du rapport de monitoring (/monitoring par défaut).
NO_DATABASE Paramètre pour désactiver les graphiques jdbc, le compteur sql et le monitoring de base de données ("false" par défaut).
OBSOLETE_GRAPHS_DAYS Nombre de jours avant qu'un fichier de graphique JRobin (extension .rrd) qui n'est plus utilisé, soit considéré comme obsolète et soit supprimé automatiquement, à minuit (90 par défaut, soit 3 mois).
OBSOLETE_STATS_DAYS Nombre de jours avant qu'un fichier de statistiques (extension .ser.gz), soit considéré comme obsolète et soit supprimé automatiquement, à minuit (365 par défaut, soit 1 an).
PLUGIN_AUTHENTICATION_DISABLED Désactive la vérification de l'authentification sur la page du monitoring dans le plugin Jenkins ou dans le plugin JIRA/Confluence/Bamboo, de manière à pouvoir utiliser le serveur de collecte centralisé (false par défaut).
QUARTZ_DEFAULT_LISTENER_DISABLED Paramètre pour désactiver le listener sur le scheduler par défaut de Quartz ("false" par défaut).
RESOLUTION_SECONDS Résolution des courbes en secondes (60 par défaut).
REWRAP_DATASOURCES Si Tomcat et si JNDI est utilisé pour les datasources, active le rewraping des datasources au lieu de faire du rebinding dans JNDI (false par défaut).
SAMPLING_EXCLUDED_PACKAGES Liste de packages exclus du sampling ("java,sun,com.sun,javax,org.apache,org.hibernate,oracle,org.postgresql,org.eclipse" par défaut).
SAMPLING_INCLUDED_PACKAGES List of packages to include for sampling, can be used if sampling-excluded-packages is null (null by default).
SAMPLING_SECONDS Période en secondes du sampling pour trouver les hotspots (null par défaut : pas de sampling).
SERVICES_TRANSFORM_PATTERN Expression régulière (null par défaut) pour transformer la description d'une méthode de façade autre que ejb3, spring ou guice (ie par MonitoringProxy).
SEVERE_THRESHOLD_MILLIS Seuil en millisecondes pour décompte en niveau severe (moyenne globale + 2 * écart-type par défaut).
SPRING_TRANSFORM_PATTERN Expression régulière (null par défaut) pour transformer la description d'une méthode spring.
SQL_TRANSFORM_PATTERN Expression régulière (null par défaut) pour transformer la description de la requête sql (identifiants non bindés dans une clause in par exemple) afin de permettre l'agrégation sur ces requêtes.
STORAGE_DIRECTORY Nom du répertoire de stockage (monitoring par défaut).
STRUTS_TRANSFORM_PATTERN Expression régulière (null par défaut) pour transformer la description d'une action Struts 2.
SYSTEM_ACTIONS_ENABLED Active les actions systèmes telles que Ramasse-miettes, Invalidation sessions et Heap-dump (true par défaut).
TRANSPORT_FORMAT Format du transport entre un serveur de collecte et une application monitorée (serialized : sérialisation java par défaut et recommandée pour les performances, xml : possible).
URL_EXCLUDE_PATTERN Expression régulière pour exclure certaines urls du monitoring (null par défaut).
WARNING_THRESHOLD_MILLIS Seuil en millisecondes pour décompte en niveau warning (moyenne globale + 1 écart-type par défaut).

Method Summary

Methods

Modifier and Type	Method and Description
String	getCode()
static Parameter	valueOf(String name) Returns the enum constant of this type with the specified name.
static Parameter[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

RESOLUTION_SECONDS

public static final Parameter RESOLUTION_SECONDS

Résolution des courbes en secondes (60 par défaut). Une résolution entre 60 et 600 est recommandée (c'est-à-dire 1 à 10 minutes).

OBSOLETE_GRAPHS_DAYS

public static final Parameter OBSOLETE_GRAPHS_DAYS

Nombre de jours avant qu'un fichier de graphique JRobin (extension .rrd) qui n'est plus utilisé, soit considéré comme obsolète et soit supprimé automatiquement, à minuit (90 par défaut, soit 3 mois).

OBSOLETE_STATS_DAYS

public static final Parameter OBSOLETE_STATS_DAYS

Nombre de jours avant qu'un fichier de statistiques (extension .ser.gz), soit considéré comme obsolète et soit supprimé automatiquement, à minuit (365 par défaut, soit 1 an).

SAMPLING_SECONDS

public static final Parameter SAMPLING_SECONDS

Période en secondes du sampling pour trouver les hotspots (null par défaut : pas de sampling). Une valeur de 10 est recommandée (c'est-à-dire 10 secondes) pour ne pas entraîner d'overhead, ce qui nécessitera plusieurs heures pour avoir des résultats significatifs. Cette période peut-être une valeur décimale comme 0.1 pour avoir des résultats plus rapidement, mais avec un plus grand overhead.

STORAGE_DIRECTORY

public static final Parameter STORAGE_DIRECTORY

Nom du répertoire de stockage (monitoring par défaut). Si le nom du répertoire commence par '/', on considère que c'est un chemin absolu, sinon on considère que c'est un chemin relatif par rapport au répertoire temporaire ('temp' dans TOMCAT_HOME pour tomcat).

LOG

public static final Parameter LOG

Active le log des requêtes http au niveau INFO (false par défaut).

WARNING_THRESHOLD_MILLIS

public static final Parameter WARNING_THRESHOLD_MILLIS

Seuil en millisecondes pour décompte en niveau warning (moyenne globale + 1 écart-type par défaut).

SEVERE_THRESHOLD_MILLIS

public static final Parameter SEVERE_THRESHOLD_MILLIS

Seuil en millisecondes pour décompte en niveau severe (moyenne globale + 2 * écart-type par défaut).

URL_EXCLUDE_PATTERN

public static final Parameter URL_EXCLUDE_PATTERN

Expression régulière pour exclure certaines urls du monitoring (null par défaut). Voir http://java.sun.com/javase/6/docs/api/java/util/regex/Pattern.html

HTTP_TRANSFORM_PATTERN

public static final Parameter HTTP_TRANSFORM_PATTERN

Expression régulière (null par défaut) pour transformer la description de la requête http et pour supprimer des parties variables (identifiant d'objet par exemple) afin de permettre l'agrégation sur ces requêtes.

SQL_TRANSFORM_PATTERN

public static final Parameter SQL_TRANSFORM_PATTERN

Expression régulière (null par défaut) pour transformer la description de la requête sql (identifiants non bindés dans une clause in par exemple) afin de permettre l'agrégation sur ces requêtes.

EJB_TRANSFORM_PATTERN

public static final Parameter EJB_TRANSFORM_PATTERN

Expression régulière (null par défaut) pour transformer la description d'une méthode ejb3.

JPA_TRANSFORM_PATTERN

public static final Parameter JPA_TRANSFORM_PATTERN

Expression régulière (null par défaut) pour transformer la description d'une requête jpa.

SPRING_TRANSFORM_PATTERN

public static final Parameter SPRING_TRANSFORM_PATTERN

Expression régulière (null par défaut) pour transformer la description d'une méthode spring.

GUICE_TRANSFORM_PATTERN

public static final Parameter GUICE_TRANSFORM_PATTERN

Expression régulière (null par défaut) pour transformer la description d'une méthode guice.

SERVICES_TRANSFORM_PATTERN

public static final Parameter SERVICES_TRANSFORM_PATTERN

Expression régulière (null par défaut) pour transformer la description d'une méthode de façade autre que ejb3, spring ou guice (ie par MonitoringProxy).

STRUTS_TRANSFORM_PATTERN

public static final Parameter STRUTS_TRANSFORM_PATTERN

Expression régulière (null par défaut) pour transformer la description d'une action Struts 2.

JSF_TRANSFORM_PATTERN

public static final Parameter JSF_TRANSFORM_PATTERN

Expression régulière (null par défaut) pour transformer la description d'une action JSF.

ERROR_TRANSFORM_PATTERN

public static final Parameter ERROR_TRANSFORM_PATTERN

Expression régulière (null par défaut) pour transformer la description d'une erreur http.

LOG_TRANSFORM_PATTERN

public static final Parameter LOG_TRANSFORM_PATTERN

Expression régulière (null par défaut) pour transformer la description d'un log.

JOB_TRANSFORM_PATTERN

public static final Parameter JOB_TRANSFORM_PATTERN

Expression régulière (null par défaut) pour transformer le nom d'un job.

JSP_TRANSFORM_PATTERN

public static final Parameter JSP_TRANSFORM_PATTERN

Expression régulière (null par défaut) pour transformer le nom d'une page jsp.

DISPLAYED_COUNTERS

public static final Parameter DISPLAYED_COUNTERS

Compteurs affichés: mettre "http,sql,error,log,ejb" pour afficher les ejb3 ou "http,sql,error,log,spring" pour afficher les beans spring ("http,sql,error,log" par défaut).

CUSTOM_REPORTS

public static final Parameter CUSTOM_REPORTS

Liste des noms de rapports personnalisés (null par défaut).

SAMPLING_EXCLUDED_PACKAGES

public static final Parameter SAMPLING_EXCLUDED_PACKAGES

Liste de packages exclus du sampling ("java,sun,com.sun,javax,org.apache,org.hibernate,oracle,org.postgresql,org.eclipse" par défaut).

SAMPLING_INCLUDED_PACKAGES

public static final Parameter SAMPLING_INCLUDED_PACKAGES

List of packages to include for sampling, can be used if sampling-excluded-packages is null (null by default).

NO_DATABASE

public static final Parameter NO_DATABASE

Paramètre pour désactiver les graphiques jdbc, le compteur sql et le monitoring de base de données ("false" par défaut).

QUARTZ_DEFAULT_LISTENER_DISABLED

public static final Parameter QUARTZ_DEFAULT_LISTENER_DISABLED

Paramètre pour désactiver le listener sur le scheduler par défaut de Quartz ("false" par défaut).

GZIP_COMPRESSION_DISABLED

public static final Parameter GZIP_COMPRESSION_DISABLED

Paramètre pour désactiver la compression des flux http ("false" par défaut).

SYSTEM_ACTIONS_ENABLED

public static final Parameter SYSTEM_ACTIONS_ENABLED

Active les actions systèmes telles que Ramasse-miettes, Invalidation sessions et Heap-dump (true par défaut).

CSRF_PROTECTION_ENABLED

public static final Parameter CSRF_PROTECTION_ENABLED

Active la protection contre CSRF (false par défaut).

ALLOWED_ADDR_PATTERN

public static final Parameter ALLOWED_ADDR_PATTERN

Expression régulière (null par défaut) pour restreindre l'accès au monitoring à certaines adresses IP.

AUTHORIZED_USERS

public static final Parameter AUTHORIZED_USERS

List of authorized users for BASIC auth, when you do no want to use a realm and "security-constraint" in web.xml.
Format : user:password, one by line or separated by comma

 user1:pwd1, user2:pwd2
 user3:pwd3
 

PLUGIN_AUTHENTICATION_DISABLED

public static final Parameter PLUGIN_AUTHENTICATION_DISABLED

Désactive la vérification de l'authentification sur la page du monitoring dans le plugin Jenkins ou dans le plugin JIRA/Confluence/Bamboo, de manière à pouvoir utiliser le serveur de collecte centralisé (false par défaut). Le paramètre allowed-addr-pattern pourra être utilisé pour n'autoriser que le serveur de collecte pour l'obtention des données dans Jenkins/JIRA/Confluence/Bamboo.

DISABLED

public static final Parameter DISABLED

Désactive le monitoring (false par défaut).

DATASOURCES

public static final Parameter DATASOURCES

Liste des datasources jdbc quand elles ne peuvent trouvées automatiquement dans JNDI (null par défaut).

REWRAP_DATASOURCES

public static final Parameter REWRAP_DATASOURCES

Si Tomcat et si JNDI est utilisé pour les datasources, active le rewraping des datasources au lieu de faire du rebinding dans JNDI (false par défaut). Cela permet de monitorer les requêtes SQL dans le cas où les datasources sont récupérées une fois pour toute et que l'initialisation de JavaMelody ne peux être faite avant (hibernate par exemple). Cela est utilisé notamment dans le plugin Atlassian pour JIRA.

MAIL_SESSION

public static final Parameter MAIL_SESSION

Nom JNDI de la session mail pour l'envoi par mail de rapport de hebdomadaire (null par défaut).

ADMIN_EMAILS

public static final Parameter ADMIN_EMAILS

Liste des adresses mails séparées par des virgules des destinataires pour l'envoi par mail de rapport de hebdomadaire (null par défaut).

MAIL_PERIODS

public static final Parameter MAIL_PERIODS

Liste des périodes d'envoi des mails séparées par des virgules pour l'envoi par mail de rapport de hebdomadaire. Les périodes doivent être "day", "week" ou "month" ("week" par défaut).

TRANSPORT_FORMAT

public static final Parameter TRANSPORT_FORMAT

Format du transport entre un serveur de collecte et une application monitorée (serialized : sérialisation java par défaut et recommandée pour les performances, xml : possible).
Selon http://code.google.com/p/thrift-protobuf-compare/wiki/Benchmarking?ts=1237772203&updated=Benchmarking, la sérialisation java est 75% plus performante en temps que xml (xstream/xpp) et à peine plus gourmande en taille de flux.

LOCALE

public static final Parameter LOCALE

To fix the locale of the reports (default to null, ie locale is given by the language of the browser).
Example values: "en_US", "en", "fr_FR", "de_DE" or "pt_BR"

MONITORING_PATH

public static final Parameter MONITORING_PATH

URL du rapport de monitoring (/monitoring par défaut).

ANALYTICS_ID

public static final Parameter ANALYTICS_ID

Identifiant de suivi google analytics s'il y a lieu (désactivé par défaut).

CONTEXT_FACTORY_ENABLED

public static final Parameter CONTEXT_FACTORY_ENABLED

Expérimental, ne pas utiliser.

DNS_LOOKUPS_DISABLED

public static final Parameter DNS_LOOKUPS_DISABLED

true | false, true will return localhost/127.0.0.1 for hostname/hostaddress, false will attempt dns lookup for hostname (default: false).

CONNECTIONS_STACK_TRACES_DISABLED

public static final Parameter CONNECTIONS_STACK_TRACES_DISABLED

true | false, true will disable opening stack-traces of jdbc connections (default: false).

JAVAMELODY_SWING_URL

public static final Parameter JAVAMELODY_SWING_URL

URL http du fichier jar javamelody-swing (null par défaut : le fichier sera téléchargé depuis https://github.com/javamelody/javamelody selon la version).
Ce paramètre est surtout utile quand les utilisateurs n'ont pas accès à Internet pour télécharger sur github.

LOGGER_CLASS

public static final Parameter LOGGER_CLASS

Name of a class to use for JavaMelody logs (default: null for detection of Logback, Log4J or java.util.logging).
The class must implement the interface net.bull.javamelody.JavaMelodyLogger, such as net.bull.javamelody.Log4JLogger, net.bull.javamelody.JavaLogger or net.bull.javamelody.LogbackLogger.

Method Detail

values

public static Parameter[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (Parameter c : Parameter.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static Parameter valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

getCode

public String getCode()

Returns:

code de l'enum tel qu'il doit être paramétré