Enum Class Parameter

java.lang.Object
java.lang.Enum<Parameter>
net.bull.javamelody.Parameter
All Implemented Interfaces:
Serializable, Comparable<Parameter>, java.lang.constant.Constable

public enum Parameter extends Enum<Parameter>
Liste des paramètres, tous optionnels.
Author:
Emeric Vernat
  • Nested Class Summary

    Nested classes/interfaces inherited from class java.lang.Enum

    Enum.EnumDesc<E extends Enum<E>>
  • Enum Constant Summary

    Enum Constants
    Enum Constant
    Description
    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).
    Expression régulière (null par défaut) pour restreindre l'accès au monitoring à certaines adresses IP.
    Identifiant de suivi google analytics s'il y a lieu (désactivé par défaut).
    Explicit name of the monitored application (in case the automatic name detection fails somehow).
    Explicit version of the monitored application (to override the version from Maven files for example).
    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
    Namespace to use in AWS CloudWatch to send metrics, for example "MyCompany/MyAppDomain" (null by default).
    true | false, true will disable opening stack-traces of jdbc connections (default: false).
    Parameter to enable or disable the Content Security Policy header (true by default).
    Expérimental, ne pas utiliser.
    Active la protection contre CSRF (false par défaut).
    Liste des noms de rapports personnalisés (null par défaut).
    Datadog host for accessing API.
    API key of the Datadog to send metrics, for example: 9775a026f1ca7d1c6c5af9d94d9595a4 (null by default).
    Liste des datasources jdbc quand elles ne peuvent trouvées automatiquement dans JNDI (null par défaut).
    Désactive le monitoring (false par défaut).
    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).
    true | false, true will return localhost/127.0.0.1 for hostname/hostaddress, false will attempt dns lookup for hostname (default: false).
    Expression régulière (null par défaut) pour transformer la description d'une méthode ejb3.
    Expression régulière (null par défaut) pour transformer la description d'une erreur http.
    Address of the Graphite server to send metrics to, for example: 11.22.33.44:2003 (null by default).
    Expression régulière (null par défaut) pour transformer la description d'une méthode guice.
    Paramètre pour désactiver la compression des flux http ("false" par défaut).
    Bucket name to use AWS S3 to send heap dump files (null by default).
    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.
    API token for InfluxDB authentication, which can be used instead of basic authentication with username and password or token in the InfluxDB URL (null by default).
    URL of the InfluxDB server to send metrics to, for example: http://11.22.33.44:8086/write?
    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).
    Expose counters as JMX mbeans.
    Expression régulière (null par défaut) pour transformer le nom d'un job.
    Expression régulière (null par défaut) pour transformer la description d'une requête jpa.
    Expression régulière (null par défaut) pour transformer la description d'une action JSF.
    Expression régulière (null par défaut) pour transformer le nom d'une page jsp.
    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"
    Active le log des requêtes http au niveau INFO (false par défaut).
    Expression régulière (null par défaut) pour transformer la description d'un log.
    Name of a class to use for JavaMelody logs (default: null for detection of Logback, Log4J or java.util.logging).
    Liste des périodes d'envoi des mails séparées par des virgules pour l'envoi par mail de rapport de hebdomadaire.
    Nom JNDI de la session mail pour l'envoi par mail de rapport de hebdomadaire (null par défaut).
    Used to specify prefix of the subject of the email notifications sent out by Javamelody.
    Comma separated list of Maven repositories URLs (https://repo1.maven.org/maven2/ by default).
    Maximum of disk usage by rrd files (20 MB by default).
    URL du rapport de monitoring (/monitoring par défaut).
    Paramètre pour désactiver les graphiques jdbc, le compteur sql et le monitoring de base de données ("false" par défaut).
    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).
    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).
    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).
    Paramètre pour désactiver le listener sur le scheduler par défaut de Quartz ("false" par défaut).
    Résolution des courbes en secondes (60 par défaut).
    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).
    If Real User Monitoring enabled by injecting Boomerang javascript into html page ("false" by default).
    Liste de packages exclus du sampling ("java,sun,com.sun,javax,org.apache,org.hibernate,oracle,org.postgresql,org.eclipse" par défaut).
    List of packages to include for sampling, can be used if sampling-excluded-packages is null (null by default).
    Période en secondes du sampling pour trouver les hotspots (null par défaut : pas de sampling).
    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).
    Seuil en millisecondes pour décompte en niveau severe (moyenne globale + 2 * écart-type par défaut).
    Expression régulière (null par défaut) pour transformer la description d'une méthode spring.
    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.
    Address of the StatsD server to send metrics to, for example: 11.22.33.44:8125 (null by default).
    Prefix of metrics that are sent to the StatsD server.
    Nom du répertoire de stockage (monitoring par défaut).
    Expression régulière (null par défaut) pour transformer la description d'une action Struts 2.
    Active les actions systèmes telles que Ramasse-miettes, Invalidation sessions et Heap-dump (true par défaut).
    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).
    Désactive l'update-check (false par défaut).
    Expression régulière pour exclure certaines urls du monitoring (null par défaut).
    Seuil en millisecondes pour décompte en niveau warning (moyenne globale + 1 écart-type par défaut).
    Valeur de l'entête http X-Frame-Options, par exemple, DENY, SAMEORIGIN, ALLOW-FROM http://example.com, ALLOWALL (SAMEORIGIN par défaut).
  • Method Summary

    Modifier and Type
    Method
    Description
     
     
    boolean
     
    void
    Définit la valeur d'un paramètre en tant que propriété système.
    static Parameter
    Returns the enum constant of this class with the specified name.
    static Parameter[]
    Returns an array containing the constants of this enum class, in the order they are declared.

    Methods inherited from class java.lang.Object

    getClass, notify, notifyAll, wait, wait, wait
  • Enum Constant Details

    • 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).
    • MAX_RRD_DISK_USAGE_MB

      public static final Parameter MAX_RRD_DISK_USAGE_MB
      Maximum of disk usage by rrd files (20 MB by default).
    • 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).
    • X_FRAME_OPTIONS

      public static final Parameter X_FRAME_OPTIONS
      Valeur de l'entête http X-Frame-Options, par exemple, DENY, SAMEORIGIN, ALLOW-FROM http://example.com, ALLOWALL (SAMEORIGIN par défaut).
    • CONTENT_SECURITY_POLICY_ENABLED

      public static final Parameter CONTENT_SECURITY_POLICY_ENABLED
      Parameter to enable or disable the Content Security Policy header (true by default).
    • 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.
    • UPDATE_CHECK_DISABLED

      public static final Parameter UPDATE_CHECK_DISABLED
      Désactive l'update-check (false par défaut).
    • 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_SUBJECT_PREFIX

      public static final Parameter MAIL_SUBJECT_PREFIX
      Used to specify prefix of the subject of the email notifications sent out by Javamelody. Supports one argument index {0} which will be replaced by application name at runtime.
      For e.g. : Production environment JavaMelody Reports for {0} (Monitoring JavaMelody on {0} by default).
    • 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).
    • 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 JavaMelodyLogger, such as net.bull.javamelody.internal.common.Log4JLogger, net.bull.javamelody.internal.common.Log4J2Logger, net.bull.javamelody.internal.common.JavaLogger or net.bull.javamelody.internal.common.LogbackLogger.
    • JMX_EXPOSE_ENABLED

      public static final Parameter JMX_EXPOSE_ENABLED
      Expose counters as JMX mbeans. Disabled by default.
    • APPLICATION_NAME

      public static final Parameter APPLICATION_NAME
      Explicit name of the monitored application (in case the automatic name detection fails somehow).
    • APPLICATION_VERSION

      public static final Parameter APPLICATION_VERSION
      Explicit version of the monitored application (to override the version from Maven files for example).
    • MAVEN_REPOSITORIES

      public static final Parameter MAVEN_REPOSITORIES
      Comma separated list of Maven repositories URLs (https://repo1.maven.org/maven2/ by default).
    • RUM_ENABLED

      public static final Parameter RUM_ENABLED
      If Real User Monitoring enabled by injecting Boomerang javascript into html page ("false" by default).
    • GRAPHITE_ADDRESS

      public static final Parameter GRAPHITE_ADDRESS
      Address of the Graphite server to send metrics to, for example: 11.22.33.44:2003 (null by default).
    • STATSD_ADDRESS

      public static final Parameter STATSD_ADDRESS
      Address of the StatsD server to send metrics to, for example: 11.22.33.44:8125 (null by default).
    • STATSD_PREFIX

      public static final Parameter STATSD_PREFIX
      Prefix of metrics that are sent to the StatsD server. Default value is "javamelody.context.host." where context and host gets replaced by the actual values.
    • CLOUDWATCH_NAMESPACE

      public static final Parameter CLOUDWATCH_NAMESPACE
      Namespace to use in AWS CloudWatch to send metrics, for example "MyCompany/MyAppDomain" (null by default).
    • HEAP_DUMP_S3_BUCKETNAME

      public static final Parameter HEAP_DUMP_S3_BUCKETNAME
      Bucket name to use AWS S3 to send heap dump files (null by default).
    • INFLUXDB_URL

      public static final Parameter INFLUXDB_URL
      URL of the InfluxDB server to send metrics to, for example: http://11.22.33.44:8086/write?db=mydb (null by default).
    • INFLUXDB_API_TOKEN

      public static final Parameter INFLUXDB_API_TOKEN
      API token for InfluxDB authentication, which can be used instead of basic authentication with username and password or token in the InfluxDB URL (null by default).
    • DATADOG_API_KEY

      public static final Parameter DATADOG_API_KEY
      API key of the Datadog to send metrics, for example: 9775a026f1ca7d1c6c5af9d94d9595a4 (null by default).
    • DATADOG_API_HOST

      public static final Parameter DATADOG_API_HOST
      Datadog host for accessing API. 'api.datadoghq.com' is default.
  • Method Details

    • values

      public static Parameter[] values()
      Returns an array containing the constants of this enum class, in the order they are declared.
      Returns:
      an array containing the constants of this enum class, in the order they are declared
    • valueOf

      public static Parameter valueOf(String name)
      Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class 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é
    • getValue

      public String getValue()
      Returns:
      valeur du paramètre
    • getValueAsBoolean

      public boolean getValueAsBoolean()
      Returns:
      valeur du paramètre
    • setValue

      public void setValue(String value)
      Définit la valeur d'un paramètre en tant que propriété système.
      Parameters:
      value - Valeur