Monitor

This section lists the elements you can use to configure Monitoring.

This page discusses:

LoggingConfig

  • com.exalead.mercury.mami.master.v10.LoggingConfig
  • Data model General Logging configuration, for generic process logs. Specific system (crawler, query) have their specific log policy.
  • Attributes:
    Name Type Default value Description
    version long
    enableTimeBasedLogRotation boolean Rotates process log files each day at midnight.
    logRotationCronExpression string Custom Quartz Cron expression to trigger log rotation. Only taken into account if enableTimeBasedLogRotation is false.
    logRotationMaxSizeKB long If set, process log files are rotated when bigger than the specified number of kilobytes.
    logPurgeMaxSizeKB long If set, process log files are purged (older first) when their total size is above the specified number.
    logExpirationDays long If set, process log files are purged when older than the specified number of days.
    logInSyslog boolean If set, log are also copied in syslog with type=daemon, ident=cloudview, message="AppenderName: logMessage" This producs this type of line in /var/log/daemon.log: "Mar 19 12:10:47 madpc125 cloudview: index.clustermanager: Building slice list for st0"
  • Nested elements:
    Name Type Description
    GlobalLoggerConfig com.exalead.mercury.mami.master.v10.GlobalLoggerConfig
    LoggingLevel com.exalead.mercury.mami.master.v10.LoggingLevel*

GlobalLoggerConfig

  • com.exalead.mercury.mami.master.v10.GlobalLoggerConfig
  • Global logger module configuration.
  • Parent elements:
    • com.exalead.mercury.mami.master.v10.LoggingConfig (as LoggingConfig)
  • Attributes:
    Name Type Default value Description
    maxSize int 100 Max size of the RAM buffer that stores latest messages.
    enableGlobalLogEntryStore boolean Keeps all logs (in these case, an additional structure is created on disk and GetGlobalLogEntryList can be called).

LoggingLevel

  • com.exalead.mercury.mami.master.v10.LoggingLevel
  • Logging level configuration.
  • Parent elements:
    • com.exalead.mercury.mami.master.v10.LoggingConfig (as LoggingConfig)
  • Attributes:
    Name Type Default value Description
    level string Logging level. The following values are available: error, warning, info, notice, debug, and trace.
    host string Host for which this logging level should be applied. If null, the configuration applies to every host of the cluster.
    install string Instance for which this logging level should be applied. If null, the configuration applies to every instance of the cluster.
    process string Process for which this logging level should be applied. If null, the configuration applies to every process of the selected host (or every host if host is null).
    logger string Logger for which this logging level should be applied. If null, the configuration applies to every logger.

SetLoggingLevel

  • com.exalead.mercury.mami.master.v10.SetLoggingLevel
  • Dynamically updates the logging level of a given process.
  • Parent elements:
    • com.exalead.mercury.mami.master.v10.LoggingConfig (as LoggingConfig)
  • Attributes:
    Name Type Default value Description
    level string Logging level. The following values are available: error, warning, info, notice, debug, and trace.
    host string Host for which this logging level should be applied. If null, the configuration applies to every host of the cluster.
    install string Instance for which this logging level should be applied. If null, the configuration applies to every instance of the cluster.
    process string Process for which this logging level should be applied. If null, the configuration applies to every process of the selected host (or every host if host is null).
    logger string Logger for which this logging level should be applied. If null, the configuration applies to every logger.

ReportingConfig

  • com.exalead.cloudview.reporting.v10.ReportingConfig
  • No documentation for this element.
  • Attributes:
    Name Type Default value Description
    httpProxyHost string Address of the HTTP proxy to send usage data report and diagnostics to Exalead
    httpProxyPort int Port of the HTTP proxy to send usage data report and diagnostics to Exalead
    httpProxyLogin string Login of the HTTP proxy to send usage data report and diagnostics to Exalead
    httpProxyPassword string Password of the HTTP proxy to send usage data report and diagnostics to Exalead
  • Nested elements:
    Name Type Description
    CustomReportField com.exalead.cloudview.reporting.v10.CustomReportField*
    NotificationsConfig com.exalead.cloudview.reporting.v10.NotificationsConfig
    PerformanceMonitoringConfig com.exalead.cloudview.reporting.v10.PerformanceMonitoringConfig
    SearchDynamicReportingConfig com.exalead.cloudview.reporting.v10.SearchDynamicReportingConfig
    SearchStaticReportingConfig com.exalead.cloudview.reporting.v10.SearchStaticReportingConfig
    ServiceReportingConfig com.exalead.cloudview.reporting.v10.ServiceReportingConfig
    UsageDataReportConfig com.exalead.cloudview.reporting.v10.UsageDataReportConfig

HttpHeaderField

  • com.exalead.cloudview.reporting.v10.HttpHeaderField
  • No documentation for this element.
  • Parent elements:
    • com.exalead.cloudview.reporting.v10.ReportingConfig (as ReportingConfig)
  • Attributes:
    Name Type Default value Description
    fieldName string
    headerName string

HttpParamField

  • com.exalead.cloudview.reporting.v10.HttpParamField
  • No documentation for this element.
  • Parent elements:
    • com.exalead.cloudview.reporting.v10.ReportingConfig (as ReportingConfig)
  • Attributes:
    Name Type Default value Description
    fieldName string
    paramName string

NotificationsConfig

  • com.exalead.cloudview.reporting.v10.NotificationsConfig
  • No documentation for this element.
  • Parent elements:
    • com.exalead.cloudview.reporting.v10.ReportingConfig (as ReportingConfig)
  • Attributes:
    Name Type Default value Description
    enabled boolean True
    licenseNotificationEnabled boolean True
    processesNotificationEnabled boolean True
    indexingNotificationEnabled boolean True
    searchNotificationEnabled boolean True
    tokenNotificatioEnabled boolean True
    tokenNotificationThreshold double 0.8
    sender string
    recipient string
    subjectPrefix string [CloudView]
  • Nested elements:
    Name Type Description
    SMTPServer com.exalead.cloudview.reporting.v10.SMTPServer

SMTPServer

  • com.exalead.cloudview.reporting.v10.SMTPServer
  • SMTP Server used to send mails concerning reporting of your Cloudview instance.
  • Parent elements:
    • com.exalead.cloudview.reporting.v10.NotificationsConfig (as NotificationsConfig)
  • Attributes:
    Name Type Default value Description
    username string Username used to connect to the SMTP server.
    password string Password associated to the username.
    host string localhost Hostname of the SMTP server.
    port int 25 Port of the targeted SMTP server.
    tls boolean Enables the TLS (Transport Layer Security) protocol for this server.

PerformanceMonitoringConfig

  • com.exalead.cloudview.reporting.v10.PerformanceMonitoringConfig
  • Monitoring-Console configuration
  • Parent elements:
    • com.exalead.cloudview.reporting.v10.ReportingConfig (as ReportingConfig)
  • Attributes:
    Name Type Default value Description
    monitoringIntervalS int 60 Interval in seconds between two monitoring probes. Value must be higher or equal to 4
    timeout int 20 Timeout value in seconds for network activity
    collectorThreads int 6
    enabled boolean True Enables monitoring
    rrddir string ${dataDir}/perfmonitoring/probe Directory where probes files (rrd) are stored.
    configdir string ${dataDir}/perfmonitoring/config Directory parsed to find xml configuration files.
    tmpdir string ${dataDir}/perfmonitoring/tmp Temporary directory used internally.
    libspath string ${installDir}/extrajava/jrds/ List of jar files or directory containing probes.
    autocreate boolean True Enables the auto-creation of configdir and rrddir.
    onlyForInstallName string If set, restricts monitoring to a specific install name.
  • Nested elements:
    Name Type Description
    monitoredPageCaches exa.bee.StringValue* List of PageCache to monitor.
    MonitoredHost com.exalead.cloudview.reporting.v10.MonitoredHost* Additional host probes
    MonitoredIndexField com.exalead.cloudview.reporting.v10.MonitoredIndexField* List of index field to monitor.
    MonitoredIndexFieldConfig com.exalead.cloudview.reporting.v10.MonitoredIndexFieldConfig Global index fied monitoring config
    PerformanceMonitoringTimer com.exalead.cloudview.reporting.v10.PerformanceMonitoringTimer* Additional timers

MonitoredHost

  • com.exalead.cloudview.reporting.v10.MonitoredHost
  • No documentation for this element.
  • Parent elements:
    • com.exalead.cloudview.reporting.v10.PerformanceMonitoringConfig (as PerformanceMonitoringConfig)
  • Attributes:
    Name Type Default value Description
    name string
  • Nested elements:
    Name Type Description
    MonitoredHostConnection com.exalead.cloudview.reporting.v10.MonitoredHostConnection*
    MonitoredHostProbe com.exalead.cloudview.reporting.v10.MonitoredHostProbe*

MonitoredHostConnection

  • com.exalead.cloudview.reporting.v10.MonitoredHostConnection
  • How to connect to a monitored host.
  • Parent elements:
    • com.exalead.cloudview.reporting.v10.MonitoredHost (as MonitoredHost)
  • Attributes:
    Name Type Default value Description
    type string Connection type. Must not be empty.
    name string Connection name. Must not be empty.
  • Nested elements:
    Name Type Description
    MonitoredHostElementArg com.exalead.cloudview.reporting.v10.MonitoredHostElementArg* List of arguments for connection. Currently unused.

MonitoredHostElementArg

  • com.exalead.cloudview.reporting.v10.MonitoredHostElementArg
  • No documentation for this element.
  • Parent elements:
    • com.exalead.cloudview.reporting.v10.MonitoredHostConnection (as MonitoredHostConnection)
    • com.exalead.cloudview.reporting.v10.MonitoredHostProbe (as MonitoredHostProbe)
    • com.exalead.cloudview.reporting.v10.MonitoredHostProbe (as argList)
  • Attributes:
    Name Type Default value Description
    type string
    value string

MonitoredHostProbe

  • com.exalead.cloudview.reporting.v10.MonitoredHostProbe
  • A monitoring probe
  • Parent elements:
    • com.exalead.cloudview.reporting.v10.MonitoredHost (as MonitoredHost)
  • Attributes:
    Name Type Default value Description
    type string The probe type
    label string The descriptive label of the probe
    connection string The name of the MonitoredHostConnection used by the probe.
  • Nested elements:
    Name Type Description
    argList com.exalead.cloudview.reporting.v10.MonitoredHostElementArg* The list of MonitoredHostElementArg (one per argument of the probe)
    MonitoredHostElementArg com.exalead.cloudview.reporting.v10.MonitoredHostElementArg* The list of MonitoredHostElementArg (one per argument of the probe).

MonitoredIndexField

  • com.exalead.cloudview.reporting.v10.MonitoredIndexField
  • No documentation for this element.
  • Parent elements:
    • com.exalead.cloudview.reporting.v10.PerformanceMonitoringConfig (as PerformanceMonitoringConfig)
  • Attributes:
    Name Type Default value Description
    name string

MonitoredIndexFieldConfig

  • com.exalead.cloudview.reporting.v10.MonitoredIndexFieldConfig
  • No documentation for this element.
  • Parent elements:
    • com.exalead.cloudview.reporting.v10.PerformanceMonitoringConfig (as PerformanceMonitoringConfig)
  • Attributes:
    Name Type Default value Description
    monitorAllFacetFields boolean True If true, monitor all the Value and Category fields

PerformanceMonitoringTimer

  • com.exalead.cloudview.reporting.v10.PerformanceMonitoringTimer
  • Timer configuration. A timer is identified by a name and is composed of one or several probe types.
  • Parent elements:
    • com.exalead.cloudview.reporting.v10.PerformanceMonitoringConfig (as PerformanceMonitoringConfig)
  • Attributes:
    Name Type Default value Description
    monitoringIntervalS int 60 Interval in seconds between two monitoring probes. Value must be higher or equal to 4
    timeout int 20 Timeout value in seconds for network activity
    collectorThreads int 6
    name string Identifier name of the timer
  • Nested elements:
    Name Type Description
    probeTypes exa.bee.StringValue* List of probe types using this timer. Probe types that are not referenced by any timer use the default one.

SearchDynamicReportingConfig

  • com.exalead.cloudview.reporting.v10.SearchDynamicReportingConfig
  • Dynamic Reporting configuration
  • Parent elements:
    • com.exalead.cloudview.reporting.v10.ReportingConfig (as ReportingConfig)
  • Attributes:
    Name Type Default value Description
    enabled boolean Enables automatic report generations
  • Nested elements:
    Name Type Description
    SearchDynamicReportingConfigNames com.exalead.cloudview.reporting.v10.SearchDynamicReportingConfigNames Generated reporting configuration element names.

SearchDynamicReportingConfigNames

  • com.exalead.cloudview.reporting.v10.SearchDynamicReportingConfigNames
  • Contains names of configuration elements used by the dynamic reporting
  • Parent elements:
    • com.exalead.cloudview.reporting.v10.SearchDynamicReportingConfig (as SearchDynamicReportingConfig)
  • Attributes:
    Name Type Default value Description
    hostName string
    installName string
    papiPort int
    reportingConnector string
    reportingBuildGroup string
    reportingDataModel string
    reportingTaskQueue string
    reportingIndexBuilder string
    reportingSearchTarget string
    reportingSearchLogic string

SearchStaticReportingConfig

  • com.exalead.cloudview.reporting.v10.SearchStaticReportingConfig
  • Static Reporting configuration
  • Parent elements:
    • com.exalead.cloudview.reporting.v10.ReportingConfig (as ReportingConfig)
  • Attributes:
    Name Type Default value Description
    enabled boolean True Enables automatic report generations
    reportCron string Quartz Cron expression triggering global static report generation.
    reportApplicationCron string 0 10 0 * * ? Quartz Cron expression triggering static report generation on applications. The default setting is every day at 00:10. Reports are generated for each deployed application.
    topLimit int 100 Maximum number of rows to retrieve while computing ordered results (for example, top queries).
    maxVersionsToKeep int 30 Maximum number of resource versions to keep in the StaticReportList. 0 means no limit is enforced, whereas 1 will keep only the most recent version.
  • Nested elements:
    Name Type Description
    ApplicationReportScheduling com.exalead.cloudview.reporting.v10.ApplicationReportScheduling* List of application reports scheduling. Each application can have a scheduled search static reporting. Each application report scheduling is defined by the application id and a Quartz Cron expression.

ApplicationReportScheduling

  • com.exalead.cloudview.reporting.v10.ApplicationReportScheduling
  • Associate a Quartz Cron expression to a specific application in order to trigger its reporting generation
  • Parent elements:
    • com.exalead.cloudview.reporting.v10.SearchStaticReportingConfig (as SearchStaticReportingConfig)
  • Attributes:
    Name Type Default value Description
    cron string
    applicationId string

ServiceReportingConfig

  • com.exalead.cloudview.reporting.v10.ServiceReportingConfig
  • No documentation for this element.
  • Parent elements:
    • com.exalead.cloudview.reporting.v10.ReportingConfig (as ReportingConfig)
  • Nested elements:
    Name Type Description
    ReporterConfig com.exalead.cloudview.reporting.v10.ReporterConfig*

ReporterConfig

  • com.exalead.cloudview.reporting.v10.ReporterConfig
  • No documentation for this element.
  • Parent elements:
    • com.exalead.cloudview.reporting.v10.ServiceReportingConfig (as ServiceReportingConfig)
  • Attributes:
    Name Type Default value Description
    name string
  • Nested elements:
    Name Type Description
    ReportingPublisher com.exalead.cloudview.reporting.v10.ReportingPublisher*

PAPIReportingPublisher

  • com.exalead.cloudview.reporting.v10.PAPIReportingPublisher
  • Base class for PAPI Publishers.
  • Parent elements:
    • com.exalead.cloudview.reporting.v10.ReporterConfig (as ReporterConfig)
  • Attributes:
    Name Type Default value Description
    synchronous boolean
    closeTimeoutMS int
    batchTimeoutMS int 1000
    minBatchSize int 50
    maxBatchSize int 250
    maxQueueSize int 250
    publishedFields string
    host string Hostname of the reporting publisher
    port int Port of the reporting publisher
    connectorName string Name of the reporting publisher

CSVReportingPublisher

  • com.exalead.cloudview.reporting.v10.CSVReportingPublisher
  • Base class for CSV Publishers.
  • Parent elements:
    • com.exalead.cloudview.reporting.v10.ReporterConfig (as ReporterConfig)
  • Attributes:
    Name Type Default value Description
    synchronous boolean
    closeTimeoutMS int
    batchTimeoutMS int 1000
    minBatchSize int 50
    maxBatchSize int 250
    maxQueueSize int 250
    publishedFields string
    file string
    maxFileSizeMB int 50 0 means no rotation is triggered by the file size
    rotateEveryNMonths int 0 means no rotation is triggered by the file age in month
    rotateEveryNDays int 1 0 means no rotation is triggered by the file age in day
    rotateEveryNHours int 0 means no rotation is triggered by the file age in hour
    maxSizeToKeepMB int 2500 Maximum csv reporting files volume in megaoctet. The oldest files are discarded at rotation time. 0 means no limit is enforced.
    maxFileToKeep int 50 Maximum csv reporting files to keep. The oldest files are discarded at rotation time. 0 means no limit is enforced, whereas 1 will discards all rotated files.
    maxDayToKeep int 30 Maximum csv reporting file age in day to keep. The oldest files are discarded at rotation time. 0 means no limit is enforced, whereas 1 only keep todays files.

JDBCReportingPublisher

  • com.exalead.cloudview.reporting.v10.JDBCReportingPublisher
  • Base class for JDBC Publishers.
  • Parent elements:
    • com.exalead.cloudview.reporting.v10.ReporterConfig (as ReporterConfig)
  • Attributes:
    Name Type Default value Description
    synchronous boolean
    closeTimeoutMS int
    batchTimeoutMS int 1000
    minBatchSize int 50
    maxBatchSize int 250
    maxQueueSize int 250
    publishedFields string
    driver string JDBC driver fully qualified Java class name.
    connectionString string JDBC connection string. This is vendor specific.
    login string Login for the database connection.
    password string Password for the database connection.
    table string Table where data must be inserted.
    insertQuery string Query used to insert data in the table.

ReportingStorePublisher

  • com.exalead.cloudview.reporting.v10.ReportingStorePublisher
  • Base class for PAPI Publishers.
  • Parent elements:
    • com.exalead.cloudview.reporting.v10.ReporterConfig (as ReporterConfig)
  • Attributes:
    Name Type Default value Description
    synchronous boolean
    closeTimeoutMS int
    batchTimeoutMS int 1000
    minBatchSize int 50
    maxBatchSize int 250
    maxQueueSize int 250
    publishedFields string
    schema string
    rotationCron string 0 0 0 * * ? Quartz Cron expression to force a rotation. A rotation is also triggered every time a collection is queried.
    maxRowCount long 100000 Maximum count of line in the database. When this size is reached the oldest records are discarded. 0 means there is no limit to the database size.

UsageDataReportConfig

  • com.exalead.cloudview.reporting.v10.UsageDataReportConfig
  • Configuration of the Usage Data Reporting (UDR). UDR allows 3DS EXALEAD to improve its products thanks to anonymous information on their use.
  • Parent elements:
    • com.exalead.cloudview.reporting.v10.ReportingConfig (as ReportingConfig)
  • Attributes:
    Name Type Default value Description
    enabled boolean Should usage data be sent regularly to 3DS EXALEAD?

StringValue

  • exa.bee.StringValue
  • No documentation for this element.
  • Parent elements:
    • com.exalead.cloudview.reporting.v10.PerformanceMonitoringConfig (as monitoredPageCaches)
    • com.exalead.cloudview.reporting.v10.PerformanceMonitoringTimer (as probeTypes)
  • Attributes:
    Name Type Default value Description
    value string