herence.ce.coherence.14.1.1-0-12.source-code.coherence-report-config.xsd Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of coherence Show documentation
Show all versions of coherence Show documentation
Oracle Coherence Community Edition
Copyright (c) 2000, 2021, Oracle and/or its affiliates.
Licensed under the Universal Permissive License v 1.0 as shown at
http://oss.oracle.com/licenses/upl.
This is the XML Schema Definition for the report-config.xml configuration
file.
The report-config element is the root element of the report
configuration
descriptor.
Used in: n/a
The report element contains information necessary to generate a JMX
based
report.
Used in: report-config
The description element contains a descriptive heading for the associated report or column.
The file-name element contains the file name for the generated report.
The file name could be either absolute or relative to a directory
specified in
the corresponding report-group descriptor.
If the specified file exists then the new report lines will be
appended to the
file; otherwise a new report file will be created.
The file name may contain any of the three special macros: {batch},
{node} and {date}.
The {batch} macro is replaced with an execution counter (a
sequential number), which is used to generate new files
for each report execution.
The {node} macro is replaced with the member id of the report executing
node. Use this macro to create different files for reports executed on
different cluster nodes.
The {date} macro is replaced with the current date (YYYYMMDD).
Note: a process running the reporter requires read/write/create access to
the location where the output files are created.
The delim element specifies a character that is used to separate column
or array values.
Valid values: "{tab}", "{space}", or any non-whitespace character.
The hide-headers element specifies whether the description and the
column headers should be included in the report.
Used in: report
Valid values are true or false (default).
The filters element contains a group of filter elements.
Used in: report
The filter element defines a set of filters that can be used in the
report.
Used in: filters
The params element identifies an argument column or a filter reference.
Used in: filter, column
The query element contains information necessary to construct a JMX
query to find all MBeans contributing to the report or column.
Used in: report, column
The pattern element contains a JMX query or Object name to be
included in the report.
Example: include all Node MBeans in the report or column.
Coherence:type=Node,*
Example: include only the Cluster MBean in the report or column
Coherence:type=Cluster
The pattern string allows macro substitutions with runtime values
that come from report columns.
Example: to provide a cache name into the query pattern one can define a
system property called reporter.cacheName and use the following
construct:
Coherence:type=Cache,name={CacheName},*
property
reporter.cacheName
Sometimes a query pattern is known to result in a list of MBean
names that have a well known key attribute. That key attribute
could be used to retrieve an attribute from a related (joined)
MBean.
Example: since "Coherence:type=Service,*" pattern is known to result in
MBeans in the following format: "Coherence:type=Service,nodeId=NNN",
the configuration below is used to print the MemberName attribute
from a corresponding NodeMBean along with the ServiceName attribute
for the ServiceMBean.
Coherence:type=Service,*
MemberName
NodeId
ServiceName
attribute
MemberName
Coherence:type=Node,nodeId={NodeId}
key
nodeId
key
name
The row element contains a list of columns to be included in the
report.
Used in: report-config
The column element contains information that the Reporter uses to
generate a report column.
Used in: row
The type element identifies an XmlFilter or XmlColumn implementation.
The column/type element defines the type of the column in the
report.
Valid values:
attribute A column which contains the data from a MBean
attribute (default).
key A column which contains the value from a MBean key
attribute.
method A column which contains the result of an MBean method
invocation.
function A column which contains the result of a function
or aggregation. See function-name below.
global A column that contains a value not related to any specific
MBean. Global column names are {report-time},
{report-count}, {node-id}.
constant A column which contains a constant string of numeric
value.
property A column which contains a value of a Java system
property.
The filter/type element defines the type of the filter in the
report.
Valid values:
equals Filter which compares the result of two or more column
references for a value equality.
greater Filter which compares the results of two column references
for "greater than" condition. If any of the values is
resolved to null, the evaluation yields false. (This
approach is equivalent to the way the NULL values are
handled by SQL.)
less Filter which compares the results of two column references
for "less than" condition. If any of the values is resolved to
null, the evaluation yields false.
not Filter which returns the logical "not" of a filter reference.
and Filter which returns the logical "and" of two filter references.
or Filter which returns the logical "or" of two filter references.
Used in: filter, column
The function-name is the name of the calculation to apply to the
associated MBean attribute values.
This element is only valid when the column type is "function".
Valid values:
- sum - The sum of all retrieved attribute values.
- avg - The average value for all retrieved attribute values.
- min - The minimum numeric value for all retrieved attribute
values.
- max The maximum numeric value for all retrieved attribute
values.
- add The sum of values for two column references.
- subtract The difference between values for two column
references.
- multiply The product of values for two column references.
- divide The ratio between values for two column
references.
Used in: column
The name element represents an attribute or method name on the MBean.
For composite data types the name element can contain a forward
slash (/) delimited name sequence.
Used in: column
The header element contains the column header. If this item is
omitted, the value of the "name" element is used instead.
Used in: column
The filter-ref element contains a reference to a filter id.
The filter-ref is used to pass a filter as an argument to a
query or another filter.
Used in: params
The column-ref element contains a reference to a column
identifier. The column-ref is used to pass a column value
as an argument to a filter or another column.
Used in: params
The data-type element contains the data type of a column.
Valid values: double, string, boolean, character, byte,
short, integer, long, float.
Used in: column
The value element contains the value of a constant column.
Used in: column
The hide element specifies whether or not the column value
should be hidden in the report.
Valid values: true, false, {non-MT}.
Used in: column
The group-by element specifies whether the column should
be included in the "group by" clause of the query.
Valid values are true or false (default).
Used in : column
The subquery element specifies whether the column is included
as part of a subquery
Valid values are true or false (default).
Used in : column
The return-neg element specifies if a negative value should be
returned to the query. Negative values are considered "error"
or "not available" codes on Coherence MBeans. By default these
codes will be returned as zero to not impact and column calculations.
Valid values are true or false (default).
Used in : column
The init-params element contains method invocation parameter
configuration info.
Used in: column
The init-param element contains a parameter configuration info.
Used in: init-params
The param-type element specifies the Java type of the initialization
parameter.
Supported types are:
- string - indicates that the value is a java.lang.String
- int - indicates that the value is a java.lang.Integer
- long - indicates that the value is a java.lang.Long
- double -indicates that the value is a java.lang.Double
- boolean -indicates that the value is a java.lang.Boolean
- float -indicates that the value is a java.lang.Float
- date -indicates that the value is a java.util.Date
Used in: init-param
The param-value element specifies a value of the initialization
parameter.
The value is in a format specific to the type of the parameter.
Used in: init-param