Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Aligned FLIP-102 with code of FLINK-14435

...

JVM

VM

Flink Compose

user conf key

configuration key

metric max

metric used

JVM

JVM Heap

FrameWork Heap

taskmanager.memory.framework.heap.size

configurationmemoryConfiguration.frameworkHeap

metrics.heapMax

metrics.heapUsed

Task Heap

taskmanager.memory.task.heap.size

configurationmemoryConfiguration.taskHeap

JVM None-Heap

JVM MetaSpace

taskmanager.memory.jvm-metaspace.size

configurationmemoryConfiguration.jvmMetaSpacejvmMetaspace

metrics.metaspaceMax

metrics.metaspaceUsed

JVM Overhead

taskmanager.memory.jvm-overhead.min

configurationmemoryConfiguration.jvmOverhead

metrics.nonHeapMax



metrics.nonHeapUsed

taskmanager.memory.jvm-overhead.max

other

-

-

Outside JVM

Mapped

-

-

-

metrics.mappedMax

metrics.mappedUsed

Direct

FrameWork OffHeap

taskmanager.memory.framework.off-heap.size

configurationmemoryConfiguration.frameworkOffHeap

metrics.directMax - metrics.networkMemoryTotal

metrics.directUsed - metrics.shuffleMemoryTotal

Task OffHeap Memory

taskmanager.memory.task.off-heap.size

configurationmemoryConfiguration.taskOffHeap

Network Memory

taskmanager.memory.network.min

configurationmemoryConfiguration.networkMemory

metrics.networkMemoryTotal

metrics.shuffleMemoryUsed

taskmanager.memory.network.max

Flink Managed

Managed Memory

taskmanager.memory.managed.size

configurationmemoryConfiguration.managedMemory

metrics.managedMemoryTotal

metrics.managedMemoryUsed

Additionally, memoryConfiguration.totalFlinkMemory  and totalProcessMemory are exposed through the REST API.

Frontend Design (out-dated)

...

  • task manager's resource contains this information, show it in 
  • url: /taskmanagers/:taskmanagerid

    Code Block
    languagejs
    titleJSON Schema of response
    collapsetrue
    {
      "type" : "object",
      "id" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:taskmanager:TaskManagerDetailsInfo",
      "properties" : {
        "id" : {
          "type" : "any"
        },
        "path" : {
          "type" : "string"
        },
        "dataPort" : {
          "type" : "integer"
        },
        "timeSinceLastHeartbeat" : {
          "type" : "integer"
        },
        "slotsNumber" : {
          "type" : "integer"
        },
        "freeSlots" : {
          "type" : "integer"
        },
        "hardware" : {
          "type" : "object",
          "id" : "urn:jsonschema:org:apache:flink:runtime:instance:HardwareDescription",
          "properties" : {
            "cpuCores" : {
              "type" : "integer"
            },
            "physicalMemory" : {
              "type" : "integer"
            },
            "freeMemory" : {
              "type" : "integer"
            },
            "managedMemory" : {
              "type" : "integer"
            }
          }
        },
        "configurationmemoryConfiguration" : {
          "type" : "object",
          "id" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:taskmanager:TaskManagerResourceInfoTaskExecutorMemoryConfiguration",
          "properties" : {
            "frameworkHeap" : {
              "type" : "long"
            },
            "frameworkOffHeap" : {
              "type" : "long"
            },
            "taskHeap" : {
              "type" : "long"
            },
            "taskOffHeap" : {
              "type" : "long"
            },
            "networkMemory" : {
              "type" : "long"
            },
            "managedMemory" : {
              "type" : "long"
            },
            "jvmMetaSpacejvmMetaspace" : {
              "type" : "long"
            },
            "jvmOverhead" : {
              "type" : "long"
            },
            "totalFlinkMemory" : {
              "type" : "long"
            }
            "totalProcessMemory" : {
              "type" : "long"
            }
          }
        },
        "metrics" : {
          "type" : "object",
          "id" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:taskmanager:TaskManagerMetricsInfo",
          "properties" : {
            "heapUsed" : {
              "type" : "integer"
            },
            "heapCommitted" : {
              "type" : "integer"
            },
            "heapMax" : {
              "type" : "integer"
            },
            "metaspaceUsed" : {
              "type" : "integer"
            },
            "metaspaceCommitted" : {
              "type" : "integer"
            },
            "metaspaceMax" : {
              "type" : "integer"
            },      
            "nonHeapUsed" : {
              "type" : "integer"
            },
            "nonHeapCommitted" : {
              "type" : "integer"
            },
            "nonHeapMax" : {
              "type" : "integer"
            },
            "directCount" : {
              "type" : "integer"
            },
            "directUsed" : {
              "type" : "integer"
            },
            "directMax" : {
              "type" : "integer"
            },
            "mappedCount" : {
              "type" : "integer"
            },
            "mappedUsed" : {
              "type" : "integer"
            },
            "mappedMax" : {
              "type" : "integer"
            },
            "memorySegmentsAvailable" : {
              "type" : "integer"
            },
            "memorySegmentsTotal" : {
              "type" : "integer"
            },
            "managedMemoryUsed" : {
              "type" : "long"
            },
            "managedMemoryTotal" : {
              "type" : "long"
            },
            "networkMemoryUsed" : {
              "type" : "long"
            },
            "networkMemoryTotal" : {
              "type" : "long"
            },
            "garbageCollectors" : {
              "type" : "array",
              "items" : {
                "type" : "object",
                "id" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:taskmanager:TaskManagerMetricsInfo:GarbageCollectorInfo",
                "properties" : {
                  "name" : {
                    "type" : "string"
                  },
                  "count" : {
                    "type" : "integer"
                  },
                  "time" : {
                    "type" : "integer"
                  }
                }
              }
            }
          }
        }
      }
    }


...