MySQL NDB Cluster 8.1 Manual
MySQL NDB Cluster 8.0 Manual
NDB Cluster Internals Manual
This section provides information about the data types defined by the MGM API.
The types described in this section are all defined in the file
/storage/ndb/include/mgmapi/mgmapi.h, with
the exception of
Ndb_logevent_type,
ndb_mgm_event_severity,
ndb_mgm_logevent_handle_error, and
ndb_mgm_event_category, which are defined in
/storage/ndb/include/mgmapi/ndb_logevent.h.
- Description
This is used to classify the different types of nodes in an NDB Cluster.
- Enumeration values
-
Possible values are shown, along with descriptions, in the following table:
Table 3.1 Type ndb_mgm_node_type values and descriptions.
Value Description NDB_MGM_NODE_TYPE_UNKNOWNUnknown NDB_MGM_NODE_TYPE_APIAPI Node (SQL node) NDB_MGM_NODE_TYPE_NDBData node NDB_MGM_NODE_TYPE_MGMManagement node
- Description
This type describes a Cluster node's status.
- Enumeration values
-
Possible values are shown, along with descriptions, in the following table:
Table 3.2 Type ndb_mgm_node_status values and descriptions.
Value Description NDB_MGM_NODE_STATUS_UNKNOWNThe node's status is not known NDB_MGM_NODE_STATUS_NO_CONTACTThe node cannot be contacted NDB_MGM_NODE_STATUS_NOT_STARTEDThe node has not yet executed the startup protocol NDB_MGM_NODE_STATUS_STARTINGThe node is executing the startup protocol NDB_MGM_NODE_STATUS_STARTEDThe node is running NDB_MGM_NODE_STATUS_SHUTTING_DOWNThe node is shutting down NDB_MGM_NODE_STATUS_RESTARTINGThe node is restarting NDB_MGM_NODE_STATUS_SINGLEUSERThe node is running in single-user (maintenance) mode NDB_MGM_NODE_STATUS_RESUMEThe node is in resume mode NDB_MGM_NODE_STATUS_CONNECTEDThe node is connected
- Description
The values for this type are the error codes that may be generated by MGM API functions. These may be found in Section 3.5, “MGM API Errors”.
See also ndb_mgm_get_latest_error(), for more information.
- Description
-
These are the types of log events available in the MGM API, grouped by event category. (See The ndb_mgm_event_category Type.)
Most of these log event types have one or more corresponding log event messages; these are listed in NDB Cluster Log Messages.
- Enumeration values
-
Possible values are shown, along with descriptions, in the following table:
Table 3.3 Type Ndb_logevent_type values, descriptions, and event categories
Type Description Category NDB_LE_ConnectedThe node has connected NDB_MGM_EVENT_CATEGORY_CONNECTIONNDB_LE_DisconnectedThe node was disconnected NDB_MGM_EVENT_CATEGORY_CONNECTIONNDB_LE_CommunicationClosedCommunication with the node has been closed NDB_MGM_EVENT_CATEGORY_CONNECTIONNDB_LE_CommunicationOpenedCommunication with the node has been started NDB_MGM_EVENT_CATEGORY_CONNECTIONNDB_LE_ConnectedApiVersionThe API version used by an API node; in the case of a MySQL server (SQL node), this is the same as displayed by SELECT VERSION()NDB_MGM_EVENT_CATEGORY_CONNECTIONNDB_LE_GlobalCheckpointStartedA global checkpoint has been started NDB_MGM_EVENT_CATEGORY_CHECKPOINTNDB_LE_GlobalCheckpointCompletedA global checkpoint has been completed NDB_MGM_EVENT_CATEGORY_CHECKPOINTNDB_LE_LocalCheckpointStartedThe node has begun a local checkpoint NDB_MGM_EVENT_CATEGORY_CHECKPOINTNDB_LE_LocalCheckpointCompletedThe node has completed a local checkpoint NDB_MGM_EVENT_CATEGORY_CHECKPOINTNDB_LE_LCPStoppedInCalcKeepGciThe lcoal checkpoint was aborted, but the last global checkpoint was preserved NDB_MGM_EVENT_CATEGORY_CHECKPOINTNDB_LE_LCPFragmentCompletedCopying of a table fragment was completed NDB_MGM_EVENT_CATEGORY_CHECKPOINTNDB_LE_NDBStartStartedThe node has begun to start NDB_MGM_EVENT_CATEGORY_STARTUPNDB_LE_NDBStartCompletedThe node has completed the startup process NDB_MGM_EVENT_CATEGORY_STARTUPNDB_LE_STTORRYRecievedThe node received an STTORRYsignal, indicating that the reading of configuration data is underway; see Configuration Read Phase (STTOR Phase -1), and STTOR Phase 0, for more informationNDB_MGM_EVENT_CATEGORY_STARTUPNDB_LE_StartPhaseCompletedA node start phase has been completed NDB_MGM_EVENT_CATEGORY_STARTUPNDB_LE_CM_REGCONFThe node has received a CM_REGCONFsignal; see STTOR Phase 1, for more informationNDB_MGM_EVENT_CATEGORY_STARTUPNDB_LE_CM_REGREFThe node has received a CM_REGREFsignal; see STTOR Phase 1, for more informationNDB_MGM_EVENT_CATEGORY_STARTUPNDB_LE_FIND_NEIGHBOURSThe node has discovered its neighboring nodes in the cluster NDB_MGM_EVENT_CATEGORY_STARTUPNDB_LE_NDBStopStartedThe node is beginning to shut down NDB_MGM_EVENT_CATEGORY_STARTUPNDB_LE_NDBStopCompletedNode shutdown completed NDB_MGM_EVENT_CATEGORY_STARTUPNDB_LE_NDBStopForcedThe node is being forced to shut down (usually indicates a severe problem in the cluster) NDB_MGM_EVENT_CATEGORY_STARTUPNDB_LE_NDBStopAbortedThe started to shut down, but was forced to continue running; this happens, for example, when a STOPcommand was issued in the management client for a node such that the cluster would no longer be able to keep all data available if the node were shut downNDB_MGM_EVENT_CATEGORY_STARTUPNDB_LE_StartREDOLogRedo logging has been started NDB_MGM_EVENT_CATEGORY_STARTUPNDB_LE_StartLogLogging has started NDB_MGM_EVENT_CATEGORY_STARTUPNDB_LE_UNDORecordsExecutedThe node has read and executed all records from the redo log NDB_MGM_EVENT_CATEGORY_STARTUPNDB_LE_StartReportThe node is issuing a start report NDB_MGM_EVENT_CATEGORY_STARTUPNDB_LE_NR_CopyDictThe node is copying the data dictionary NDB_MGM_EVENT_CATEGORY_NODE_RESTARTNDB_LE_NR_CopyDistrThe node is copying data distribution information NDB_MGM_EVENT_CATEGORY_NODE_RESTARTNDB_LE_NR_CopyFragsStartedThe node is copying table fragments NDB_MGM_EVENT_CATEGORY_NODE_RESTARTNDB_LE_NR_CopyFragDoneThe node has completed copying a table fragment NDB_MGM_EVENT_CATEGORY_NODE_RESTARTNDB_LE_NR_CopyFragsCompletedThe node has completed copying all necessary table fragments NDB_MGM_EVENT_CATEGORY_NODE_RESTARTNDB_LE_NodeFailCompletedAll (remaining) nodes has been notified of the failure of a data node NDB_MGM_EVENT_CATEGORY_NODE_RESTARTNDB_LE_NODE_FAILREPA data node has failed NDB_MGM_EVENT_CATEGORY_NODE_RESTARTNDB_LE_ArbitStateThis event is used to report on the current state of arbitration in the cluster NDB_MGM_EVENT_CATEGORY_NODE_RESTARTNDB_LE_ArbitResultThis event is used to report on the outcome of node arbitration NDB_MGM_EVENT_CATEGORY_NODE_RESTARTNDB_LE_GCP_TakeoverStartedThe node is attempting to become the master node (to assume responsibility for GCPs) NDB_MGM_EVENT_CATEGORY_NODE_RESTARTNDB_LE_GCP_TakeoverCompletedThe node has become the master (and assumed responsibility for GCPs) NDB_MGM_EVENT_CATEGORY_NODE_RESTARTNDB_LE_LCP_TakeoverStartedThe node is attempting to become the master node (to assume responsibility for LCPs) NDB_MGM_EVENT_CATEGORY_NODE_RESTARTNDB_LE_LCP_TakeoverCompletedThe node has become the master (and assumed responsibility for LCPs) NDB_MGM_EVENT_CATEGORY_NODE_RESTARTNDB_LE_TransReportCountersThis indicates a report of transaction activity, which is given approximately once every 10 seconds NDB_MGM_EVENT_CATEGORY_STATISTICNDB_LE_OperationReportCountersIndicates a report on the number of operations performed by this node (also provided approximately once every 10 seconds) NDB_MGM_EVENT_CATEGORY_STATISTICNDB_LE_TableCreatedA new table has been created NDB_MGM_EVENT_CATEGORY_STATISTICNDB_LE_UndoLogBlockedUndo logging is blocked because the log buffer is close to overflowing NDB_MGM_EVENT_CATEGORY_STATISTICNDB_LE_JobStatistic... NDB_MGM_EVENT_CATEGORY_STATISTICNDB_LE_SendBytesStatisticIndicates a report of the average number of bytes transmitted per send operation by this node NDB_MGM_EVENT_CATEGORY_STATISTICNDB_LE_ReceiveBytesStatisticIndicates a report of the average number of bytes received per send operation to this node NDB_MGM_EVENT_CATEGORY_STATISTICNDB_LE_MemoryUsageA DUMP 1000command has been issued to this node, and it is reporting its memory usage in turnNDB_MGM_EVENT_CATEGORY_STATISTICNDB_LE_TransporterErrorA transporter error has occurred; see NDB Transporter Errors, for transporter error codes and messages NDB_MGM_EVENT_CATEGORY_ERRORNDB_LE_TransporterWarningA potential problem is occurring in the transporter; see NDB Transporter Errors, for transporter error codes and messages NDB_MGM_EVENT_CATEGORY_ERRORNDB_LE_MissedHeartbeatIndicates a data node has missed a hreatbeat expected from another data node NDB_MGM_EVENT_CATEGORY_ERRORNDB_LE_DeadDueToHeartbeatA data node has missed at least 3 heartbeats in succssion from another data node, and is reporting that it can no longer communicate with that data node NDB_MGM_EVENT_CATEGORY_ERRORNDB_LE_WarningEventIndicates a warning message NDB_MGM_EVENT_CATEGORY_ERRORNDB_LE_SentHeartbeatA node heartbeat has been sent NDB_MGM_EVENT_CATEGORY_INFONDB_LE_CreateLogBytes... NDB_MGM_EVENT_CATEGORY_INFONDB_LE_InfoEventIndicates an informational message NDB_MGM_EVENT_CATEGORY_INFONDB_LE_SingleUserThe cluster has entered or exited single user mode NDB_MGM_EVENT_CATEGORY_INFONDB_LE_EventBufferStatusThis type of event indicates potentially excessive usage of the event buffer NDB_MGM_EVENT_CATEGORY_INFONDB_LE_EventBufferStatus2Extension of NDB_LE_EventBufferStatusproviding improved reporting of event buffer status; added in NDB 7.5NDB_MGM_EVENT_CATEGORY_INFONDB_LE_EventBufferStatus3Extension of NDB_LE_EventBufferStatuswhich uses 64-bit values for total, maximum, and allocated bytes; added in NDB 7.5.23, 7.6.19, and 8.0.26NDB_MGM_EVENT_CATEGORY_INFONDB_LE_BackupStartedA backup has been started NDB_MGM_EVENT_CATEGORY_BACKUPNDB_LE_BackupFailedToStartA backup has failed to start NDB_MGM_EVENT_CATEGORY_BACKUPNDB_LE_BackupCompletedA backup has been completed successfully NDB_MGM_EVENT_CATEGORY_BACKUPNDB_LE_BackupAbortedA backup in progress was terminated by the user NDB_MGM_EVENT_CATEGORY_BACKUP
- Description
These are the log event severities used to filter the cluster log by
ndb_mgm_set_clusterlog_severity_filter(), and to filter listening to events byndb_mgm_listen_event().- Enumeration values
-
Possible values are shown, along with descriptions, in the following table:
Table 3.4 Type ndb_mgm_event_severity values and descriptions
Value Description NDB_MGM_ILLEGAL_EVENT_SEVERITYInvalid event severity specified NDB_MGM_EVENT_SEVERITY_ONCluster logging is enabled NDB_MGM_EVENT_SEVERITY_DEBUGUsed for NDB Cluster development only NDB_MGM_EVENT_SEVERITY_INFOInformational messages NDB_MGM_EVENT_SEVERITY_WARNINGConditions that are not errors as such, but that might require special handling NDB_MGM_EVENT_SEVERITY_ERRORNonfatal error conditions that should be corrected NDB_MGM_EVENT_SEVERITY_CRITICALCritical conditions such as device errors or out of memory errors NDB_MGM_EVENT_SEVERITY_ALERTConditions that require immediate attention, such as corruption of the cluster NDB_MGM_EVENT_SEVERITY_ALLAll severity levels
See ndb_mgm_set_clusterlog_severity_filter(), and ndb_mgm_listen_event(), for information on how this type is used by those functions.
- Description
This type is used to describe log event errors.
- Enumeration values
-
Possible values are shown, along with descriptions, in the following table:
Table 3.5 Type ndb_logevent_handle_error values and descriptions
Value Description NDB_LEH_NO_ERRORNo error NDB_LEH_READ_ERRORRead error NDB_LEH_MISSING_EVENT_SPECIFIERInvalid, incomplete, or missing log event specification NDB_LEH_UNKNOWN_EVENT_TYPEUnknown log event type NDB_LEH_UNKNOWN_EVENT_VARIABLEUnknown log event variable NDB_LEH_INTERNAL_ERRORInternal error NDB_LEH_CONNECTION_ERRORConnection error, or lost connection with management server
NDB_LEH_CONNECTION_ERROR was added in NDB
7.4.13. (BUG #19474782)
- Description
These are the log event categories referenced in The Ndb_logevent_type Type. They are also used by the MGM API functions
ndb_mgm_set_clusterlog_loglevel()andndb_mgm_listen_event().- Enumeration values
-
Possible values are shown, along with descriptions, in the following table:
Table 3.6 Type ndb_mgm_event_category values and descriptions
Value Description NDB_MGM_ILLEGAL_EVENT_CATEGORYInvalid log event category NDB_MGM_EVENT_CATEGORY_STARTUPLog events occurring during startup NDB_MGM_EVENT_CATEGORY_SHUTDOWNLog events occurring during shutdown NDB_MGM_EVENT_CATEGORY_STATISTICStatistics log events NDB_MGM_EVENT_CATEGORY_CHECKPOINTLog events related to checkpoints NDB_MGM_EVENT_CATEGORY_NODE_RESTARTLog events occurring during node restart NDB_MGM_EVENT_CATEGORY_CONNECTIONLog events relating to connections between cluster nodes NDB_MGM_EVENT_CATEGORY_BACKUPLog events relating to backups NDB_MGM_EVENT_CATEGORY_CONGESTIONLog events relating to congestion NDB_MGM_EVENT_CATEGORY_INFOUncategorised log events (severity level INFO)NDB_MGM_EVENT_CATEGORY_ERRORUncategorised log events (severity level WARNING,ERROR,CRITICAL, orALERT)
See ndb_mgm_set_clusterlog_loglevel(), and ndb_mgm_listen_event(), for more information.