FwdJMX.java
/*
** Module : FwdJMX.java
** Abstract : FWD JMX instrumentation.
**
** Copyright (c) 2020-2024, Golden Code Development Corporation.
**
** -#- -I- --Date-- ---------------------------------------Description---------------------------------------
** 001 IAS 20200930 Created initial version.
** 002 IAS 20201001 Added dump of MBean state.
** HC 20201010 Implemented map counter.
** 003 SBI 20211104 Added ThreadsCpuTimers to monitor CPU utilization by threads.
** CA 20211216 Added a task counter for the legacy service worker threads.
** IAS 20220327 Added 'registerMBean' method.
** IAS 20220626 Added SSL counters.
** AL2 20220828 Added H2 Query Profiler.
** CA 20221006 Added instrumentation for some APIs in the ORM and persistence layer. Refs #6814
** CA 20221031 Added more instrumentation for:
** - the 'execute' time at H2 statements (OrmTempTableQuery).
** - ContextLocal.get (ContextLocalGet).
** - TableMapper.mapTemporaryTable (OrmTableMapperMap).
** - TABLE/DATASET[-HANDLE] parameter processing (OrmTempTableParam, OrmDynamicTableParam,
** OrmDataSetParam, OrmDynamicDataSetParam).
** - OpenClient parameter processing (AppserverAddTableMetaData, ApperverGetJavaParameter,
** AppserverGetOutputParameter).
** AL2 20230104 Added OrmRedo.
** Added OrmNoUndoTrace.
** OM 20230112 Added finer-granulation instrumentation for processing of dynamic queries.
** 004 RAA 20230302 Removed OrmRedo and OrmNoUndoTrace.
** 005 GBB 20230512 Logging methods replaced by CentralLogger/ConversionStatus.
** 006 HC 20232012 Added SPREADSHEET widget counters.
** 007 HC 20240103 Added a counter for SPREADSHEET cache hits.
** 008 HC 20240222 Enabled JMX on FWD Client.
** 009 RAA 20240723 When trying to register an already existing MBean, abort the process.
*/
/*
** This program is free software: you can redistribute it and/or modify
** it under the terms of the GNU Affero General Public License as
** published by the Free Software Foundation, either version 3 of the
** License, or (at your option) any later version.
**
** This program is distributed in the hope that it will be useful,
** but WITHOUT ANY WARRANTY; without even the implied warranty of
** MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
** GNU Affero General Public License for more details.
**
** You may find a copy of the GNU Affero GPL version 3 at the following
** location: https://www.gnu.org/licenses/agpl-3.0.en.html
**
** Additional terms under GNU Affero GPL version 3 section 7:
**
** Under Section 7 of the GNU Affero GPL version 3, the following additional
** terms apply to the works covered under the License. These additional terms
** are non-permissive additional terms allowed under Section 7 of the GNU
** Affero GPL version 3 and may not be removed by you.
**
** 0. Attribution Requirement.
**
** You must preserve all legal notices or author attributions in the covered
** work or Appropriate Legal Notices displayed by works containing the covered
** work. You may not remove from the covered work any author or developer
** credit already included within the covered work.
**
** 1. No License To Use Trademarks.
**
** This license does not grant any license or rights to use the trademarks
** Golden Code, FWD, any Golden Code or FWD logo, or any other trademarks
** of Golden Code Development Corporation. You are not authorized to use the
** name Golden Code, FWD, or the names of any author or contributor, for
** publicity purposes without written authorization.
**
** 2. No Misrepresentation of Affiliation.
**
** You may not represent yourself as Golden Code Development Corporation or FWD.
**
** You may not represent yourself for publicity purposes as associated with
** Golden Code Development Corporation, FWD, or any author or contributor to
** the covered work, without written authorization.
**
** 3. No Misrepresentation of Source or Origin.
**
** You may not represent the covered work as solely your work. All modified
** versions of the covered work must be marked in a reasonable way to make it
** clear that the modified work is not originating from Golden Code Development
** Corporation or FWD. All modified versions must contain the notices of
** attribution required in this license.
*/
package com.goldencode.p2j.jmx;
import com.goldencode.p2j.util.logging.*;
import com.goldencode.util.*;
import javax.management.*;
import java.io.*;
import java.lang.management.*;
import java.util.*;
import java.util.logging.*;
/** FWD JMX instrumentation */
public abstract class FwdJMX
implements FwdJMXMBean
{
/** Logger. */
private static final CentralLogger LOG = CentralLogger.get(FwdJMX.class.getName());
/** MBean annotation */
private String annotation;
/**
* Default constructor
*
* @param annotation
* The annotation value.
*/
protected FwdJMX(String annotation)
{
super();
}
/**
* Get counter annotation
* @return counter annotation
*/
@Override
public String getAnnotation()
{
return annotation;
}
/**
* Set counter annotation
* @param annotation
* counter annotation
*/
@Override
public void setAnnotation(String annotation)
{
this.annotation = annotation;
}
/**
* Register MBeans
*/
public abstract void registerMBeans();
/**
* Register MBean
*
* @param mbean
* MBean to be registered
* @param name
* MBean name
*/
public final void registerMBean(Object mbean, String name)
{
try
{
MBeanServer server = ManagementFactory.getPlatformMBeanServer();
ObjectName mbeanName = new ObjectName("com.goldencode.p2j:name=" + name);
if (server.isRegistered(mbeanName))
{
return;
}
server.registerMBean(mbean, mbeanName);
}
catch (Exception e)
{
LOG.log(Level.SEVERE, "MBean registration failed", e);
}
}
/**
* Print all counters' values to the file.
*
* @param file
* The output file name (will be appended if exists).
*
* @throws IOException
* If IO exception occurs
*/
@Override
public abstract void dumpAll(String file) throws IOException;
/** Reset all counters */
@Override
public abstract void resetAll();
/**
* Enable/disable all counters
* @param val
* new value of the "enable" flag
*/
@Override
public abstract void enableAll(boolean val);
}