r4 - 2020-01-08 - 20:56:07 - TimFeeneyYou are here: TWiki >  Deployment Web > DeploymentMonitoring > JMXMBeans > MBeansReference > MBeansReference6061

JMX Application MBeans Reference Guide for

Authors: TimFeeney
Build basis:

Revised approach to documenting MBeans

  • A reference guide for a release should be wholly complete, that is, it should include new MBeans for the release but also all other released MBeans
  • Organize the MBeans for each release by
    • Java/JVM - since we don't 'own' these, it could be that these standalone outside the ELM MBean reference guides for each release
    • Foundation/Common
    • DOORS Next
    • EWM
    • LQE - this is an outlier too since we are just using MBeans available in Jena
    • Future add ETM, RMM and other apps as they pub MBeans
  • Within an application domain category, organize the MBeans alphabetically. The current organization by collector task is not meaningful to end users. Alternatively, if a reasonable functional categorization can be defined, that could be considered, e.g. cluster, performance, server health, usage, etc.
  • Each release should have release notes that indicate any changes (high level) from previous release
    • Changes to a release should NOT break client monitoring for a prior release, e.g. avoid changing object name paths
  • What to capture for each MBean:
    • Name, Object name/path
    • Advanced Property Namespace, Advanced Property Display Name, Advanced Property ID and their default values and unit of measurement (e.g. milliseconds, seconds....)
    • Description/usage/why of value
    • Default frequency and how to alter in UI and/advanced property
    • Name of collector task, TaskID used in UI
    • Attribute names with good descriptions
    • see Serviceability Component MBean Mapping especially the attached table
    • need to show examples on how to find and use an MBean in the Serviceability page, RepoDebug and some monitoring tool, e.g. Splunk

Related topics: JMX MBeans for ELM application monitoring

Edit | Attach | Printable | Raw View | Backlinks: Web, All Webs | History: r7 < r6 < r5 < r4 < r3 | More topic actions...
This site is powered by the TWiki collaboration platformCopyright © by the contributing authors. All material on this collaboration platform is the property of the contributing authors.
Contributions are governed by our Terms of Use. Please read the following disclaimer.