> ## Documentation Index
> Fetch the complete documentation index at: https://docs.activeviam.com/llms.txt
> Use this file to discover all available pages before exploring further.
# Application Performance Monitoring
Atoti APM (Application Performance Monitoring) is a solution for monitoring the healthiness and performance
of an application.
It provides several features easing the support work, and reducing the burden of maintaining and troubleshooting
Atoti Server.
## Configuration
### Adding APM in an Atoti project
You can use the APM starter to setup APM in our project.
```xml theme={"languages":{"custom":["/engine/python-sdk/0.9/languages/pycon.tmLanguage.json"]}}
com.activeviam.springboot
atoti-server-apm-starter
${project.version}
```
## Logging
APM relies on SLF4J with a Logback binding for the logging part.
### Configuration
Logback supports custom conversion specifiers allowing to display specific information properly within the logs.
APM defines three custom converter detailed below:
| Converter | Description |
| ----------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `com.activeviam.apm.api.logging.LogUserConverter` | Allow to display the current user for the thread. The user is either taken from the security layer or from the health event |
| `com.activeviam.apm.api.logging.LogThreadConverter` | Allow to display the current thread. This is useful for the health event. This converter can override the default Logback one |
| `com.activeviam.apm.api.logging.LogInstanceConverter` | Required only if ELK setup and JSON logs are used. This converter provides the node instance name specified in property `node.instance.name` so the source node of a log can be identified in a centralized logging system like ELK |
Then, Logback configuration example can make use of these converters as follows:
```xml theme={"languages":{"custom":["/engine/python-sdk/0.9/languages/pycon.tmLanguage.json"]}}
{/* Example LOGBACK Configuration File http://logback.qos.ch/manual/configuration.html */}
{/* Exposing the conversion rules */}
${custom.log.dir}/${project.artifactId}.log
${custom.log.dir}/${project.artifactId}_%d{yyyy-MM-dd}.log.gz
30
true
{/* Using the converter in the appender pattern layout */}
%d{yyyy-MM-dd HH:mm:ss.SSS} [Thread: %thread; User: %user] %-5level %logger{35} -
%msg%n
[...]
true
```
### Loggers Categorization
APM loggers could be categorized as follows:
| Category | Logger(s) |
| ------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Feeding | `com.activeviam.apm.feeding` |
| Feed loading | `com.activeviam.apm.loaded.feed`
Used if you choose the `feed.loading.message.handler.type` option 'LOG'. In this case you more likely prefer the output to be made in a separate file |
| Queries | `com.activeviam.apm.queries` |
| Distribution | `com.activeviam.apm.distribution` |
| Services | `com.activeviam.apm.services` |
| System Health | `com.activeviam.apm.health` |
| Spring | `com.activeviam.apm.spring` |
#### Data loading
The `MonitoredDataLoadingConfig` class provides the bean `messageHandler()` which creates the implementation of
the `IMessageHandler`.
In your source Spring config class you could do the following:
```java theme={"languages":{"custom":["/engine/python-sdk/0.9/languages/pycon.tmLanguage.json"]}}
...
@Autowired
private MonitoredDataLoadingConfig monitoredDataLoadingConfig;
@Bean
protected IMessageHandler> messageHandler() {
return monitoredDataLoadingConfig.messageHandler();
}
@Bean(destroyMethod = "close")
public CustomCsvSource dataCsvSource() {
final CsvSource csvSource = new CsvSource(DATA_TAG);
...
return csvSource;
}
protected List, ILineReader>> dataCsvChannels(
final CsvMessageChannelFactory dataCsvChannelFactory,
final IMessageHandler> messageHandler) {
final List, ILineReader>> channels = new ArrayList<>();
ITuplePublisher> tuplePublisher = ...;
IStoreMessageChannel, ILineReader> channel = dataCsvChannelFactory.createChannel(topicName,
storeName, tuplePublisher);
channel.withPublisher(tuplePublisher);
channel.withMessageHandler(messageHandler());
channels.add(channel);
}
```
Depending on the properties, the bean allows to:
* log start/end processing of some input data, as well as the errors, through the
logger `com.activeviam.apm.source`
* log the rejections of the input data through the logger `com.activeviam.apm.source.rejection`
* specify the property `feed.loading.message.handler.type` to select the type of the message handler:
\*\* if set to `DEFAULT`, simply logs detailed information about loading file
\*\* if set to `LOG`, logs the feed loading in an external file (CSV style) upon completion using the
logger `com.activeviam.apm.loaded.feed`
\*\* if set to `WEBHOOK`, call a webhook (external service) upon completion of the file loading
## Properties exposed
List of the properties exposed as well as their default value
| Property | Description | Default value |
| ------------------------------------------------------------------ | --------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------- |
| `activeviam.apm.config.hide.properties.pattern` | Specifies the pattern used to hide sensitive properties when logged | `*(password\|key).*` |
| `activeviam.apm.enable.all.apmanager.statistics` | Enable the MBeans statistics for the ActivePivot manager | `true` |
| `activeviam.apm.enable.xmla.servlet.logging` | Enable the logging of the XMLA Servlet | `true` |
| `activeviam.apm.enable.json.queries.service.logging` | Enable the logging of the JSON Queries Service | `true` |
| `activeviam.apm.enable.json.queries.service.detailed.logging` | Enable the detailed logging of the JSON Queries Service | `false` |
| `activeviam.apm.enable.json.queries.service.log.memory.stats` | Enable the logging of the memory stats for the JSON Queries Service | `false` |
| `activeviam.apm.enable.queries.service.logging` | Enable the logging of the Queries Service | `true` |
| `activeviam.apm.enable.queries.service.detailed.logging` | Enable the detailed logging of the Queries Service | `false` |
| `activeviam.apm.enable.queries.service.log.memory.stats` | Enable the logging of the memory stats for the Queries Service | `false` |
| `activeviam.apm.enable.streaming.service.logging` | Enable the logging of the Streaming Service | `true` |
| `activeviam.apm.enable.streaming.service.detailed.logging` | Enable the detailed logging of the Streaming Service | `false` |
| `activeviam.apm.enable.streaming.service.log.memory.stats` | Enable the logging of the memory stats for the Streaming Service | `false` |
| `activeviam.apm.enable.web.socket.logging` | Enable the logging of Web Socket | `true` |
| `activeviam.apm.enable.web.socket.detailed.logging` | Enable the detailed logging of the Web Socket | `false` |
| `activeviam.apm.enable.web.socket.log.memory.stats` | Enable the logging of the memory stats for the Web Socket | `false` |
| `activeviam.apm.feed.loading.cache.loaded.files.num.entries` | Property defining the number of entries kept in the feed loading cache | 1,000,000 |
| `activeviam.apm.feed.loading.message.handler.type` | Property defining the feed loading message handler type | `DEFAULT` |
| `activeviam.apm.feed.loading.message.handler.webhook.url` | Property defining the webhook URL for the feed loading message handler | |
| `activeviam.apm.feed.loading.message.handler.webhook.num.retries` | Property defining the number of retries for the webhook feed loading message handler | `Integer.MAX_VALUE` |
| `activeviam.apm.feed.loading.message.handler.webhook.time.to.wait` | Property defining the time to wait (ms) between each retry for the webhook feed loading message handler | `3000` (3s) |
| `activeviam.apm.jmx.thread.status.cache.timeout` | Thread status cache value timeout in milliseconds. Thread status cache value is refreshed automatically when timeout. | `60000` (60s) |
| `activeviam.apm.node.instance.name` | Unique name of the current node. It must be provided if logging/monitoring stack (e.g. ELK) is used. | activepivot |
| `activeviam.apm.consul.host` | Host or IP of the consul service | |
| `activeviam.apm.consul.port` | Port of the consul service | `8500` |
| `activeviam.apm.activepivot.service.name` | Service name of the instance. This is for service grouping and filtering in consul | activepivot |
| `activeviam.apm.node.host` | Host or IP of the node instance for registering to consul | The first non loop back host ip found in network interfaces |
| `activeviam.apm.node.healthcheck.port` | Port which consul should call for healthcheck. This should be port used for jmx explorer, e.g. `-javaagent:jmx_prometheus_javaagent-0.3.1.jar=8081` | `8081` |
| `activeviam.apm.node.healthcheck.path` | Path which consul should call for healthcheck | `metrics` |
| `activeviam.apm.node.healthcheck.interval` | Interval between health check attempts | `5m` |
| `activeviam.apm.node.healthcheck.timeout` | Timeout for a health check attempt | `30s` |
| `activeviam.apm.node.healthcheck.deregister.time` | Consul will de-register the instance from the registry if it loses contact for more that a specific time | `30m` |
| `activeviam.apm.query.performance.evaluation.min.sample.size` | The minimum amount of past performance required as samples for evaluation | `10` |
| `activeviam.apm.query.performance.evaluation.max.sample.size` | The maximum amount of past performance taken into account for evaluation | `30` |
| `activeviam.apm.query.performance.evaluation.coefficient` | The coefficient for adjusting the threshold | `1` |