Artifactory JMX MBeans
JMX MBeans provides a framework for monitoring and managing Java applications, such as the Artifactory service. Artifactory exposes MBeans under the org.jfrog.artifactory domain, which enables you to monitor repositories, executor pools, storage, and HTTP connection pools.
Note
Monitor JFrog platform services that are not Java applications using Open Metrics.
JMX MBeans Repositories
This section lists the available repositories under the current instance of Artifactory.
The following table lists the read-only attributes.
| Read-Only Attribute | Description |
|---|---|
| RepositoryKey | Name of the repository |
| ArtifactsCount | Number of artifacts in the repository |
| ArtifactsTotalSize | Total size of all of the artifacts in the repository |
JMX MBeans Federated Repositories
This section describes the Federated repository read-only attributes.
| Read-Only Attribute | Description |
|---|---|
| MaximumLagInMs | The maximum lag value from among all Federated repositories in milliseconds |
| NumberOfDisabledFederationMembers | The number of disabled Federation members (local and remote) |
| NumberOfReposExceedingLagThreshold | The total number of Federated repositories that have a sync lag larger than the default threshold |
| NumberOfMirrorsExceedingLagThreshold | The total number of mirrors (Federation members) that have a sync lag larger than the default threshold |
Note
For more information about Federated repository MBeans, see Federated Repository Metrics in MBeans.
JMX MBeans Executor Pools
This section lists the executor pools used by Artifactory.
The following table lists the read-only attributes.
| Read-Only Attribute | Description |
|---|---|
| CorePoolSize | Executor pool size |
| MaximumPoolSize | Maximum size of the executor pool |
| ActiveCount | Number of active executors |
| LargestPoolSize | The largest pool size that has been active at any one time |
| TaskCount | Total number of tasks that have ever been scheduled for execution |
| CompletedTaskCount | Total number of tasks that have been completed by the executors |
| PendingTasks | The number of tasks waiting to be processed by the executor pool |
JMX MBeans Storage
This section describes File System Binary Storage and Database Data Source read-only attributes.
Binary Storage
There is only one File System Binary Storage read-only attribute.
| Read-Only Attribute | Description |
|---|---|
| Size | Total size of Artifactory storage in bytes |
Data Source
The following table lists the database Data Source read-only attributes.
| Read-Only Attribute | Description |
|---|---|
| Url | Database URL |
| MaxIdle | Maximum number of idle database connections allowed |
| MaxWait | Timeout in ms when attempting to get a free connection |
| MinIdle | Minimum number of idle database connections to maintain |
| MaxActive | Maximum number of active connections to the database |
| ActiveConnectionsCount | Number of active database connections |
| IdleConnectionsCount | Number of idle database connections |
| SelectQueriesCount | The total number of SQL SELECT DB queries that have been executed since Artifactory startup |
| UpdateQueriesCount | The total number of SQL UPDATE DB queries that have been executed since Artifactory startup |
JMX MBeans HTTP Connection Pools
Artifactory supports JMX MBeans for the following HTTP resources:
- Remote repositories
- Distribution Repositories
- FederatedStatusService
- Xray Client Connection
- Replication Queues
- Event propagation service for Artifactory HA cluster nodes
The following read-only attributes are available for each HTTP connection pool.
| Read-Only Attribute | Description |
|---|---|
| Available | Number of available connections |
| Leased | Number of currently active connections |
| Max | The maximum number of connections possible |
| Pending | The number of connections in process and pending completion |
| ActiveConnections | The current number of active connections in the pool |
| IdleConnections | The current number of idle connections in the pool |
| TotalConnections | The total number of connections in the pool |
| ThreadsAwaitingConnection | The total number of threads awaiting connection from the pool |
Connection Pool Config
The following read-only configuration attributes are available for each HTTP connection pool.
| Read-Only Attribute | Description |
|---|---|
| MaximumPoolSize | The maximum number of connections that can be kept in the pool |
| ConnectionTimeout | The maximum number of milliseconds that a client will wait for a connection from the pool |
| ValidationTimeout | The maximum number of milliseconds that the pool will wait for a connection to be validated as alive |
| PoolName | The name of the connection pool |
| MaxLifetime | The maximum connection lifetime of the pool in milliseconds |
| IdleTimeout | The maximum amount of time that a connection is allowed to sit idle in the pool (in milliseconds) |
| Catalog | The default catalog name to be set on connection in the pool |
| MinimumIdle | The minimum number of idle connections that is maintained in the pool |
| Username | The default username used for DataSource.getConnection (username, password) calls in the pool |
| Password | The default password used for DataSource.getConnection (username, password) calls in the pool |
| LeakDetectionThreshold | The amount of time that a connection can be out of the pool before a message is logged indicating a possible connection leak |
JMX MBeans Events
The following table lists event-related attributes for:
- events.create
- events.delete
- events.props
- events.update
| Read-Only Attribute | Description |
|---|---|
| Count | The total number of metrics that have occurred since Artifactory startup |
| FifteenMinuteRate | The average rate of events per time unit over the past 15 minutes |
| OneMinuteRate | The average rate of events per time unit over the past minute |
| RateUnit | The time unit used to measure rates for metrics |
| MeanRate | The average rate of metrics per time unit since Artifactory startup |
All of the metrics described in the table above can be turned on/off using the metrics.enabled property in org.jfrog.storage.DbProperties. The default value is false.
JMX MBeans Logging
To support log analytics, Artifactory implements log appenders that send log information to Sumo Logic.
You can monitor the following log appenders through JMX MBeans.
- Access
- Console
- Request
- Traffic
For each log appender, Artifactory displays the following read-only attributes:
| Read-Only Attribute | Description |
|---|---|
| QueueMaxSize | The maximum number of log entries the queue can hold |
| QueueCurrentSize | The current number of log entries in the queue |
| QueueDiscardingThreshold | Below this remaining capacity threshold, trace and debug log entries will be discarded |
| BatchMaxSize | The maximum number of log entries a batch can contain before it is processed |
| BatchCurrentSize | The size of the current batch pending to be sent to Sumologic |
| BatchQuietPeriod | The time window (in milliseconds) log entries are collected in a batch before it is being sent to Sumologic |
| CategoryHeader | The category header value which is sent to Sumologic for this appender |
Updated about 1 month ago