Jump to

• Request
• Response

View RAM Journal Member Information

get

/management/coherence/cluster/journal/ram/members/{memberIdentifier}

Use this endpoint to view detailed operational and performance statistics for a RAM journal member. The information includes data about the journal size and journal usage. You can also view RAM journal settings.

Request

Path Parameters

• memberIdentifier: string
  An identifier of the member, it can either be the name or the nodeId of the member.

Back to Top

Response

Supported Media Types

• application/json

200 Response

A successful request that returns information about a RAM journal member

Body ()

Root Schema : journalRM

Type: object

Provides metrics for a Journal implementation.

Show Source

• backlogCount(optional): integer(int32)
  Read Only: true

  The number of serialized values that have yet to be persisted to disk.
• backlogSize(optional): integer(int32)
  Read Only: true

  The total size in bytes of the serialized values that have yet to be synced to disk.
• binaryStoreCount(optional): integer(int32)
  Read Only: true

  The number of active BinaryStore objects that are using this Journal
• bufferSize(optional): integer(int32)
  Read Only: true

  The size of the buffers used to write a chunk of data to the journal
• collectorLoadFactor(optional): number(double)
  Read Only: true

  The load factor threshold at which files may be garbage collected. The larger the value, the more aggressive the compaction algorithm is.
• compactionCount(optional): integer(int32)
  Read Only: true

  Number of times compaction (garbage collection) was performed for the journal
• currentCollectorLoadFactor(optional): number(double)
  Read Only: true

  The current load factor threshold at which files are being garbage collected.
• exhaustiveCompactionCount(optional): integer(int32)
  Read Only: true

  Number of times an exhaustive compaction (full garbage collection) was performed for the journal
• exhaustiveCompactionTime(optional): integer(int64)
  Read Only: true

  Total amount of time spent performing exhaustive compaction (full garbage collection) for the journal
• fileCount(optional): integer(int32)
  Read Only: true

  The number of Journal files currently in use.
• highestLoadFactor(optional): number(double)
  Read Only: true

  The approximate high-water mark of the Journal capacity utilization.
• highFileCount(optional): integer(int32)
  Read Only: true

  The high file count after which compulsory compaction occurs for the Journal.
• location(optional): string
  Read Only: true

  The location of the MBean server
• maxBacklogSize(optional): integer(int32)
  Read Only: true

  When this value, maximum backlog size, is reached, writes are delayed until dropping below this max.
• maxFileSize(optional): integer(int64)
  Read Only: true

  The maximum size of an individual Journal file.
• maxJournalFilesNumber(optional): integer(int32)
  Read Only: true

  The maximum number of journal files.
• maxPoolSize(optional): integer(int64)
  Read Only: true

  The maximum size, in bytes, of the buffer pool.
• maxTotalRam(optional): integer(int64)
  Read Only: true

  The total amount of RAM used for this Journal.
• maxValueSize(optional): integer(int32)
  Read Only: true

  The maximum allowable size, in bytes, for serialized values.
• member(optional): string
  Name of the cluster member
• name(optional): string
  Read Only: true

  The name of the journal
• nioRam(optional): boolean
  Read Only: true

  If true, the RAM Journal is using direct buffers (NIO RAM) instead of on heap buffers.
• nodeId(optional): integer(int64)
  Read Only: true

  The ID of member to which the MBean belongs
• poolSize(optional): integer(int32)
  Read Only: true

  The total size, in bytes, of all available buffers in the pool.
• totalDataSize(optional): integer(int64)
  Read Only: true

  The amount of data currently stored for this Journal in bytes.
• totalFileSize(optional): integer(int64)
  Read Only: true

  The total size of all Journal files for this Journal.
• type(optional): string
  Read Only: true

  Allowed Values: [ "Journal" ]

  The type of the MBean

{
    "type":"object",
    "description":"Provides metrics for a Journal implementation.",
    "properties":{
        "nodeId":{
            "type":"integer",
            "format":"int64",
            "description":"The ID of member to which the MBean belongs",
            "readOnly":true
        },
        "location":{
            "type":"string",
            "description":"The location of the MBean server",
            "readOnly":true
        },
        "type":{
            "type":"string",
            "description":"The type of the MBean",
            "enum":[
                "Journal"
            ],
            "readOnly":true
        },
        "name":{
            "type":"string",
            "description":"The name of the journal",
            "readOnly":true
        },
        "member":{
            "type":"string",
            "description":"Name of the cluster member"
        },
        "bufferSize":{
            "type":"integer",
            "format":"int32",
            "description":"The size of the buffers used to write a chunk of data to the journal",
            "readOnly":true
        },
        "maxPoolSize":{
            "type":"integer",
            "format":"int64",
            "description":"The maximum size, in bytes, of the buffer pool.",
            "readOnly":true
        },
        "maxBacklogSize":{
            "type":"integer",
            "format":"int32",
            "description":"When this value, maximum backlog size, is reached, writes are delayed until dropping below this max.",
            "readOnly":true
        },
        "highFileCount":{
            "type":"integer",
            "format":"int32",
            "description":"The high file count after which compulsory compaction occurs for the Journal.",
            "readOnly":true
        },
        "maxValueSize":{
            "type":"integer",
            "format":"int32",
            "description":"The maximum allowable size, in bytes, for serialized values.",
            "readOnly":true
        },
        "maxFileSize":{
            "type":"integer",
            "format":"int64",
            "description":"The maximum size of an individual Journal file.",
            "readOnly":true
        },
        "collectorLoadFactor":{
            "type":"number",
            "format":"double",
            "description":"The load factor threshold at which files may be garbage collected. The larger the value, the more aggressive the compaction algorithm is.",
            "readOnly":true
        },
        "maxTotalRam":{
            "type":"integer",
            "format":"int64",
            "description":"The total amount of RAM used for this Journal.",
            "readOnly":true
        },
        "nioRam":{
            "type":"boolean",
            "description":"If true, the RAM Journal is using direct buffers (NIO RAM) instead of on heap buffers.",
            "readOnly":true
        },
        "backlogSize":{
            "type":"integer",
            "format":"int32",
            "description":"The total size in bytes of the serialized values that have yet to be synced to disk.",
            "readOnly":true
        },
        "backlogCount":{
            "type":"integer",
            "format":"int32",
            "description":"The number of serialized values that have yet to be persisted to disk.",
            "readOnly":true
        },
        "poolSize":{
            "type":"integer",
            "format":"int32",
            "description":"The total size, in bytes, of all available buffers in the pool.",
            "readOnly":true
        },
        "maxJournalFilesNumber":{
            "type":"integer",
            "format":"int32",
            "description":"The maximum number of journal files.",
            "readOnly":true
        },
        "binaryStoreCount":{
            "type":"integer",
            "format":"int32",
            "description":"The number of active BinaryStore objects that are using this Journal",
            "readOnly":true
        },
        "fileCount":{
            "type":"integer",
            "format":"int32",
            "description":"The number of Journal files currently in use.",
            "readOnly":true
        },
        "totalDataSize":{
            "type":"integer",
            "format":"int64",
            "description":"The amount of data currently stored for this Journal in bytes.",
            "readOnly":true
        },
        "totalFileSize":{
            "type":"integer",
            "format":"int64",
            "description":"The total size of all Journal files for this Journal.",
            "readOnly":true
        },
        "currentCollectorLoadFactor":{
            "type":"number",
            "format":"double",
            "description":"The current load factor threshold at which files are being garbage collected.",
            "readOnly":true
        },
        "highestLoadFactor":{
            "type":"number",
            "format":"double",
            "description":"The approximate high-water mark of the Journal capacity utilization.",
            "readOnly":true
        },
        "compactionCount":{
            "type":"integer",
            "format":"int32",
            "description":"Number of times compaction (garbage collection) was performed for the journal",
            "readOnly":true
        },
        "exhaustiveCompactionCount":{
            "type":"integer",
            "format":"int32",
            "description":"Number of times an exhaustive compaction (full garbage collection) was performed for the journal",
            "readOnly":true
        },
        "exhaustiveCompactionTime":{
            "type":"integer",
            "format":"int64",
            "description":"Total amount of time spent performing exhaustive compaction (full garbage collection) for the journal",
            "readOnly":true
        }
    }
}

Back to Top