HugeGraph RESTful API on Apache HugeGraph

Schema API

Mon, 01 Jan 0001 00:00:00 +0000

1.1 Schema

HugeGraph provides a single interface to get all Schema information of a graph, including: PropertyKey, VertexLabel, EdgeLabel and IndexLabel.

Method & Url

GET http://localhost:8080/graphs/{graph_name}/schema

e.g: GET http://localhost:8080/graphs/hugegraph/schema

Response Status

Response Body

{
 "propertykeys": [
 {
 "id": 7,
 "name": "price",
 "data_type": "DOUBLE",
 "cardinality": "SINGLE",
 "aggregate_type": "NONE",
 "write_type": "OLTP",
 "properties": [],
 "status": "CREATED",
 "user_data": {
 "~create_time": "2023-05-08 17:49:05.316"
 }
 },
 {
 "id": 6,
 "name": "date",
 "data_type": "TEXT",
 "cardinality": "SINGLE",
 "aggregate_type": "NONE",
 "write_type": "OLTP",
 "properties": [],
 "status": "CREATED",
 "user_data": {
 "~create_time": "2023-05-08 17:49:05.309"
 }
 },
 {
 "id": 3,
 "name": "city",
 "data_type": "TEXT",
 "cardinality": "SINGLE",
 "aggregate_type": "NONE",
 "write_type": "OLTP",
 "properties": [],
 "status": "CREATED",
 "user_data": {
 "~create_time": "2023-05-08 17:49:05.287"
 }
 },
 {
 "id": 2,
 "name": "age",
 "data_type": "INT",
 "cardinality": "SINGLE",
 "aggregate_type": "NONE",
 "write_type": "OLTP",
 "properties": [],
 "status": "CREATED",
 "user_data": {
 "~create_time": "2023-05-08 17:49:05.280"
 }
 },
 {
 "id": 5,
 "name": "lang",
 "data_type": "TEXT",
 "cardinality": "SINGLE",
 "aggregate_type": "NONE",
 "write_type": "OLTP",
 "properties": [],
 "status": "CREATED",
 "user_data": {
 "~create_time": "2023-05-08 17:49:05.301"
 }
 },
 {
 "id": 4,
 "name": "weight",
 "data_type": "DOUBLE",
 "cardinality": "SINGLE",
 "aggregate_type": "NONE",
 "write_type": "OLTP",
 "properties": [],
 "status": "CREATED",
 "user_data": {
 "~create_time": "2023-05-08 17:49:05.294"
 }
 },
 {
 "id": 1,
 "name": "name",
 "data_type": "TEXT",
 "cardinality": "SINGLE",
 "aggregate_type": "NONE",
 "write_type": "OLTP",
 "properties": [],
 "status": "CREATED",
 "user_data": {
 "~create_time": "2023-05-08 17:49:05.250"
 }
 }
 ],
 "vertexlabels": [
 {
 "id": 1,
 "name": "person",
 "id_strategy": "PRIMARY_KEY",
 "primary_keys": [
 "name"
 ],
 "nullable_keys": [
 "age",
 "city"
 ],
 "index_labels": [
 "personByAge",
 "personByCity",
 "personByAgeAndCity"
 ],
 "properties": [
 "name",
 "age",
 "city"
 ],
 "status": "CREATED",
 "ttl": 0,
 "enable_label_index": true,
 "user_data": {
 "~create_time": "2023-05-08 17:49:05.336"
 }
 },
 {
 "id": 2,
 "name": "software",
 "id_strategy": "CUSTOMIZE_NUMBER",
 "primary_keys": [],
 "nullable_keys": [],
 "index_labels": [
 "softwareByPrice"
 ],
 "properties": [
 "name",
 "lang",
 "price"
 ],
 "status": "CREATED",
 "ttl": 0,
 "enable_label_index": true,
 "user_data": {
 "~create_time": "2023-05-08 17:49:05.347"
 }
 }
 ],
 "edgelabels": [
 {
 "id": 1,
 "name": "knows",
 "source_label": "person",
 "target_label": "person",
 "frequency": "SINGLE",
 "sort_keys": [],
 "nullable_keys": [],
 "index_labels": [
 "knowsByWeight"
 ],
 "properties": [
 "weight",
 "date"
 ],
 "status": "CREATED",
 "ttl": 0,
 "enable_label_index": true,
 "user_data": {
 "~create_time": "2023-05-08 17:49:08.437"
 }
 },
 {
 "id": 2,
 "name": "created",
 "source_label": "person",
 "target_label": "software",
 "frequency": "SINGLE",
 "sort_keys": [],
 "nullable_keys": [],
 "index_labels": [
 "createdByDate",
 "createdByWeight"
 ],
 "properties": [
 "weight",
 "date"
 ],
 "status": "CREATED",
 "ttl": 0,
 "enable_label_index": true,
 "user_data": {
 "~create_time": "2023-05-08 17:49:08.446"
 }
 }
 ],
 "indexlabels": [
 {
 "id": 1,
 "name": "personByAge",
 "base_type": "VERTEX_LABEL",
 "base_value": "person",
 "index_type": "RANGE_INT",
 "fields": [
 "age"
 ],
 "status": "CREATED",
 "user_data": {
 "~create_time": "2023-05-08 17:49:05.375"
 }
 },
 {
 "id": 2,
 "name": "personByCity",
 "base_type": "VERTEX_LABEL",
 "base_value": "person",
 "index_type": "SECONDARY",
 "fields": [
 "city"
 ],
 "status": "CREATED",
 "user_data": {
 "~create_time": "2023-05-08 17:49:06.898"
 }
 },
 {
 "id": 3,
 "name": "personByAgeAndCity",
 "base_type": "VERTEX_LABEL",
 "base_value": "person",
 "index_type": "SECONDARY",
 "fields": [
 "age",
 "city"
 ],
 "status": "CREATED",
 "user_data": {
 "~create_time": "2023-05-08 17:49:07.407"
 }
 },
 {
 "id": 4,
 "name": "softwareByPrice",
 "base_type": "VERTEX_LABEL",
 "base_value": "software",
 "index_type": "RANGE_DOUBLE",
 "fields": [
 "price"
 ],
 "status": "CREATED",
 "user_data": {
 "~create_time": "2023-05-08 17:49:07.916"
 }
 },
 {
 "id": 5,
 "name": "createdByDate",
 "base_type": "EDGE_LABEL",
 "base_value": "created",
 "index_type": "SECONDARY",
 "fields": [
 "date"
 ],
 "status": "CREATED",
 "user_data": {
 "~create_time": "2023-05-08 17:49:08.454"
 }
 },
 {
 "id": 6,
 "name": "createdByWeight",
 "base_type": "EDGE_LABEL",
 "base_value": "created",
 "index_type": "RANGE_DOUBLE",
 "fields": [
 "weight"
 ],
 "status": "CREATED",
 "user_data": {
 "~create_time": "2023-05-08 17:49:08.963"
 }
 },
 {
 "id": 7,
 "name": "knowsByWeight",
 "base_type": "EDGE_LABEL",
 "base_value": "knows",
 "index_type": "RANGE_DOUBLE",
 "fields": [
 "weight"
 ],
 "status": "CREATED",
 "user_data": {
 "~create_time": "2023-05-08 17:49:09.473"
 }
 }
 ]
}

PropertyKey API

Mon, 01 Jan 0001 00:00:00 +0000

1.2 PropertyKey

Params Description:

name: The name of the property type, required.
data_type: The data type of the property type, including: bool, byte, int, long, float, double, text, blob, date, uuid. The default data type is text (Represent a string type)
cardinality: The cardinality of the property type, including: single, list, set. The default cardinality is single.

Request Body Field Description:

id: The ID value of the property type.
properties: The properties of the property type. For properties, this field is empty.
user_data: Setting the common information of the property type, such as setting the value range of the age property from 0 to 100. Currently, no validation is performed on this field, and it is only a reserved entry for future expansion.

1.2.1 Create a PropertyKey

Method & Url

POST http://localhost:8080/graphs/hugegraph/schema/propertykeys

Request Body

{
 "name": "age",
 "data_type": "INT",
 "cardinality": "SINGLE"
}

Response Status

Response Body

{
 "property_key": {
 "id": 1,
 "name": "age",
 "data_type": "INT",
 "cardinality": "SINGLE",
 "aggregate_type": "NONE",
 "write_type": "OLTP",
 "properties": [],
 "status": "CREATED",
 "user_data": {
 "~create_time": "2022-05-13 13:47:23.745"
 }
 },
 "task_id": 0
}

1.2.2 Add or Remove userdata for an existing PropertyKey

Params

action: Indicates whether the current action is to add or remove userdata. Possible values are append (add) and eliminate (remove).

Method & Url

PUT http://localhost:8080/graphs/hugegraph/schema/propertykeys/age?action=append

Request Body

{
 "name": "age",
 "user_data": {
 "min": 0,
 "max": 100
 }
}

Response Status

Response Body

{
 "property_key": {
 "id": 1,
 "name": "age",
 "data_type": "INT",
 "cardinality": "SINGLE",
 "aggregate_type": "NONE",
 "write_type": "OLTP",
 "properties": [],
 "status": "CREATED",
 "user_data": {
 "min": 0,
 "max": 100,
 "~create_time": "2022-05-13 13:47:23.745"
 }
 },
 "task_id": 0
}

1.2.3 Get all PropertyKeys

Method & Url

GET http://localhost:8080/graphs/hugegraph/schema/propertykeys

Response Status

Response Body

{
 "propertykeys": [
 {
 "id": 3,
 "name": "city",
 "data_type": "TEXT",
 "cardinality": "SINGLE",
 "properties": [],
 "user_data": {}
 },
 {
 "id": 2,
 "name": "age",
 "data_type": "INT",
 "cardinality": "SINGLE",
 "properties": [],
 "user_data": {}
 },
 {
 "id": 5,
 "name": "lang",
 "data_type": "TEXT",
 "cardinality": "SINGLE",
 "properties": [],
 "user_data": {}
 },
 {
 "id": 4,
 "name": "weight",
 "data_type": "DOUBLE",
 "cardinality": "SINGLE",
 "properties": [],
 "user_data": {}
 },
 {
 "id": 6,
 "name": "date",
 "data_type": "TEXT",
 "cardinality": "SINGLE",
 "properties": [],
 "user_data": {}
 },
 {
 "id": 1,
 "name": "name",
 "data_type": "TEXT",
 "cardinality": "SINGLE",
 "properties": [],
 "user_data": {}
 },
 {
 "id": 7,
 "name": "price",
 "data_type": "INT",
 "cardinality": "SINGLE",
 "properties": [],
 "user_data": {}
 }
 ]
}

1.2.4 Get PropertyKey according to name

Method & Url

GET http://localhost:8080/graphs/hugegraph/schema/propertykeys/age

Where age is the name of the PropertyKey to be retrieved.

VertexLabel API

Mon, 01 Jan 0001 00:00:00 +0000

1.3 VertexLabel

Assuming that the PropertyKeys listed in 1.1.3 have already been created.

Params Description:

id: The ID value of the vertex type.
name: The name of the vertex type, required.
id_strategy: The ID strategy for the vertex type, including primary key ID, auto-generated, custom string, custom number, custom UUID. The default strategy is primary key ID.
properties: The property types associated with the vertex type.
primary_keys: The primary key properties. This field must have a value when the ID strategy is PRIMARY_KEY, and must be empty for other ID strategies.
enable_label_index: Whether to enable label indexing. It is disabled by default.
index_names: The indexes created for the vertex type. See details in section 3.4.
nullable_keys: Nullable properties.
user_data: Setting the common information of the vertex type, similar to the property type.

1.3.1 Create a VertexLabel

Method & Url

POST http://localhost:8080/graphs/hugegraph/schema/vertexlabels

Request Body

{
 "name": "person",
 "id_strategy": "DEFAULT",
 "properties": [
 "name",
 "age"
 ],
 "primary_keys": [
 "name"
 ],
 "nullable_keys": [],
 "enable_label_index": true
}

Response Status

Response Body

{
 "id": 1,
 "primary_keys": [
 "name"
 ],
 "id_strategy": "PRIMARY_KEY",
 "name": "person2",
 "index_names": [
 ],
 "properties": [
 "name",
 "age"
 ],
 "nullable_keys": [
 ],
 "enable_label_index": true,
 "user_data": {}
}

Starting from version v0.11.2, hugegraph-server supports Time-to-Live (TTL) functionality for vertices. The TTL for vertices is set through VertexLabel. For example, if you want the vertices of type “person” to have a lifespan of one day, you need to set the TTL field to 86400000 (in milliseconds) when creating the “person” VertexLabel.

EdgeLabel API

Mon, 01 Jan 0001 00:00:00 +0000

1.4 EdgeLabel

Assuming PropertyKeys from version 1.2.3 and VertexLabels from version 1.3.3 have already been created.

Params Explanation

name: Name of the vertex type, required.
source_label: Name of the source vertex type, required.
target_label: Name of the target vertex type, required.
frequency: Whether there can be multiple edges between two points, can have values SINGLE or MULTIPLE, optional (default value: SINGLE).
properties: Property types associated with the edge type, optional.
sort_keys: Specifies a list of differentiating key properties when multiple associations are allowed.
nullable_keys: Nullable properties, optional (default: nullable).
enable_label_index: Whether to enable type indexing, disabled by default.

1.4.1 Create an EdgeLabel

Method & Url

POST http://localhost:8080/graphs/hugegraph/schema/edgelabels

Request Body

{
 "name": "created",
 "source_label": "person",
 "target_label": "software",
 "frequency": "SINGLE",
 "properties": [
 "date"
 ],
 "sort_keys": [],
 "nullable_keys": [],
 "enable_label_index": true
}

Response Status

Response Body

{
 "id": 1,
 "sort_keys": [
 ],
 "source_label": "person",
 "name": "created",
 "index_names": [
 ],
 "properties": [
 "date"
 ],
 "target_label": "software",
 "frequency": "SINGLE",
 "nullable_keys": [
 ],
 "enable_label_index": true,
 "user_data": {}
}

Starting from version 0.11.2 of hugegraph-server, the TTL (Time to Live) feature for edges is supported. The TTL for edges is set through EdgeLabel. For example, if you want the “knows” type of edge to have a lifespan of one day, you need to set the TTL field to 86400000 when creating the “knows” EdgeLabel, where the unit is milliseconds.

IndexLabel API

Mon, 01 Jan 0001 00:00:00 +0000

1.5 IndexLabel

Assuming PropertyKeys from version 1.1.3, VertexLabels from version 1.2.3, and EdgeLabels from version 1.3.3 have already been created.

1.5.1 Create an IndexLabel

Method & Url

POST http://localhost:8080/graphs/hugegraph/schema/indexlabels

Request Body

{
 "name": "personByCity",
 "base_type": "VERTEX_LABEL",
 "base_value": "person",
 "index_type": "SECONDARY",
 "fields": [
 "city"
 ]
}

Response Status

Response Body

{
 "index_label": {
 "id": 1,
 "base_type": "VERTEX_LABEL",
 "base_value": "person",
 "name": "personByCity",
 "fields": [
 "city"
 ],
 "index_type": "SECONDARY"
 },
 "task_id": 2
}

1.5.2 Get all IndexLabels

Method & Url

GET http://localhost:8080/graphs/hugegraph/schema/indexlabels

Response Status

Response Body

{
 "indexlabels": [
 {
 "id": 3,
 "base_type": "VERTEX_LABEL",
 "base_value": "software",
 "name": "softwareByPrice",
 "fields": [
 "price"
 ],
 "index_type": "RANGE"
 },
 {
 "id": 4,
 "base_type": "EDGE_LABEL",
 "base_value": "created",
 "name": "createdByDate",
 "fields": [
 "date"
 ],
 "index_type": "SECONDARY"
 },
 {
 "id": 1,
 "base_type": "VERTEX_LABEL",
 "base_value": "person",
 "name": "personByCity",
 "fields": [
 "city"
 ],
 "index_type": "SECONDARY"
 },
 {
 "id": 3,
 "base_type": "VERTEX_LABEL",
 "base_value": "person",
 "name": "personByAgeAndCity",
 "fields": [
 "age",
 "city"
 ],
 "index_type": "SECONDARY"
 }
 ]
}

1.5.3 Get IndexLabel by name

Method & Url

GET http://localhost:8080/graphs/hugegraph/schema/indexlabels/personByCity

Response Status

Response Body

{
 "id": 1,
 "base_type": "VERTEX_LABEL",
 "base_value": "person",
 "name": "personByCity",
 "fields": [
 "city"
 ],
 "index_type": "SECONDARY"
}

1.5.4 Delete IndexLabel by name

Deleting an IndexLabel will result in the deletion of related index data. This operation will generate an asynchronous task.

Rebuild API

Mon, 01 Jan 0001 00:00:00 +0000

1.6 Rebuild

1.6.1 Rebuild IndexLabel

Method & Url

PUT http://localhost:8080/graphs/hugegraph/jobs/rebuild/indexlabels/personByCity

Response Status

Response Body

{
 "task_id": 1
}

Note:

You can get the asynchronous job status by GET http://localhost:8080/graphs/hugegraph/tasks/${task_id} (the task_id here should be 1). See More AsyncJob RESTfull API

Vertex API

Mon, 01 Jan 0001 00:00:00 +0000

2.1 Vertex

In vertex types, the Id strategy determines the type of the vertex Id, with the corresponding relationships as follows:

Id_Strategy	id type
AUTOMATIC	number
PRIMARY_KEY	string
CUSTOMIZE_STRING	string
CUSTOMIZE_NUMBER	number
CUSTOMIZE_UUID	uuid

For the GET/PUT/DELETE API of a vertex, the id part in the URL should be passed as the id value with type information. This type information is indicated by whether the JSON string is enclosed in quotes, meaning:

Edge API

Mon, 01 Jan 0001 00:00:00 +0000

2.2 Edge

The modification of the vertex ID format also affects the ID of the edge, as well as the formats of the source vertex and target vertex IDs.

The EdgeId is formed by concatenating src-vertex-id + direction + label + sort-values + tgt-vertex-id, but the vertex ID types are not distinguished by quotation marks here. Instead, they are distinguished by prefixes:

When the ID type is number, the vertex ID in the EdgeId has a prefix L, like “L123456>1»L987654”.
When the ID type is string, the vertex ID in the EdgeId has a prefix S, like “S1:peter>1»S2:lop”.

The following example requires creating a graph schema based on the following groovy script:

Traverser API

Mon, 01 Jan 0001 00:00:00 +0000

3.1 Overview of Traverser API

HugeGraphServer provides a RESTful API interface for the HugeGraph graph database. In addition to the basic CRUD operations for vertices and edges, it also offers several traversal methods, which we refer to as the traverser API. These traversal methods implement various complex graph algorithms, making it convenient for users to analyze and explore the graph.

The Traverser API supported by HugeGraph includes:

Rank API

Mon, 01 Jan 0001 00:00:00 +0000

4.1 Rank API overview

Not only the Graph iteration （traverser) method, HugeGraph-Server also provide Rank API for recommendation purpose. You can use it to recommend some vertexes much closer to a vertex.

4.2 Details of Rank API

4.2.1 Personal Rank API

A typical scenario for Personal Rank algorithm is in recommendation application. According to the out edges of a vertex, recommend some other vertices that having the same or similar edges.

Variable API

Mon, 01 Jan 0001 00:00:00 +0000

5.1 Variables

Variables can be used to store data about the entire graph. The data is accessed and stored in the form of key-value pairs.

5.1.1 Creating or Updating a Key-Value Pair

Method & Url

PUT http://localhost:8080/graphs/hugegraph/variables/name

Request Body

{
 "data": "tom"
}

Response Status

Response Body

{
 "name": "tom"
}

5.1.2 Listing all key-value pairs

Method & Url

GET http://localhost:8080/graphs/hugegraph/variables

Response Status

Response Body

{
 "name": "tom"
}

5.1.3 Listing a specific key-value pair

Method & Url

GET http://localhost:8080/graphs/hugegraph/variables/name

Response Status

Response Body

{
 "name": "tom"
}

5.1.4 Deleting a specific key-value pair

Method & Url

DELETE http://localhost:8080/graphs/hugegraph/variables/name

Response Status

Graphs API

Mon, 01 Jan 0001 00:00:00 +0000

6.1 Graphs

6.1.1 List all graphs

Method & Url

GET http://localhost:8080/graphs

Response Status

Response Body

{
 "graphs": [
 "hugegraph",
 "hugegraph1"
 ]
}

6.1.2 Get details of the graph

Method & Url

GET http://localhost:8080/graphs/hugegraph

Response Status

Response Body

{
 "name": "hugegraph",
 "backend": "cassandra"
}

6.1.3 Clear all data of a graph, include: schema, vertex, edge and index .etc.,**This operation

requires administrator privileges**

Task API

Mon, 01 Jan 0001 00:00:00 +0000

7.1 Task

7.1.1 List all async tasks in graph

Params

status: the status of asyncTasks
limit: the max number of tasks to return

Method & Url

GET http://localhost:8080/graphs/hugegraph/tasks?status=success

Response Status

Response Body

{
	"tasks": [{
		"task_name": "hugegraph.traversal().V()",
		"task_progress": 0,
		"task_create": 1532943976585,
		"task_status": "success",
		"task_update": 1532943976736,
		"task_result": "0",
		"task_retries": 0,
		"id": 2,
		"task_type": "gremlin",
		"task_callable": "org.apache.hugegraph.api.job.GremlinAPI$GremlinJob",
		"task_input": "{\"gremlin\":\"hugegraph.traversal().V()\",\"bindings\":{},\"language\":\"gremlin-groovy\",\"aliases\":{\"hugegraph\":\"graph\"}}"
	}]
}

7.1.2 View the details of an async task

Method & Url

GET http://localhost:8080/graphs/hugegraph/tasks/2

Response Status

Response Body

{
	"task_name": "hugegraph.traversal().V()",
	"task_progress": 0,
	"task_create": 1532943976585,
	"task_status": "success",
	"task_update": 1532943976736,
	"task_result": "0",
	"task_retries": 0,
	"id": 2,
	"task_type": "gremlin",
	"task_callable": "org.apache.hugegraph.api.job.GremlinAPI$GremlinJob",
	"task_input": "{\"gremlin\":\"hugegraph.traversal().V()\",\"bindings\":{},\"language\":\"gremlin-groovy\",\"aliases\":{\"hugegraph\":\"graph\"}}"
}

7.1.3 Delete task information of an async task,won’t delete the task itself

Method & Url

DELETE http://localhost:8080/graphs/hugegraph/tasks/2

Response Status

7.1.4 Cancel an async task, the task should be able to be canceled

If you already created an async task via Gremlin API as follows:

Gremlin API

Mon, 01 Jan 0001 00:00:00 +0000

8.1 Gremlin

8.1.1 Sending a gremlin statement (GET) to HugeGraphServer for synchronous execution

Params

gremlin: The gremlin statement to be sent to HugeGraphServer for execution
bindings: Used to bind parameters. Key is a string, and the value is the bound value (can only be a string or number). This functionality is similar to MySQL’s Prepared Statement and is used to speed up statement execution.
language: The language type of the sent statement. Default is gremlin-groovy.
aliases: Adds aliases for existing variables in the graph space.

Querying vertices

Cypher API

Mon, 01 Jan 0001 00:00:00 +0000

9.1 Cypher

9.1.1 Sending a cypher statement (GET) to HugeGraphServer for synchronous execution

Method & Url

GET /graphs/{graph}/cypher?cypher={cypher}

Params

graph: Graph name
cypher: Cypher statement

Example

GET http://localhost:8080/graphs/hugecypher1/cypher?cypher=match(n:person) return n.name as name order by n.name limit 1

Response Status

Response Body

{
 "requestId": "766b9f48-2f10-40d9-951a-3027d0748ab7",
 "status": {
 "message": "",
 "code": 200,
 "attributes": {
 }
 },
 "result": {
 "data": [
 {
 "name": "hello"
 }
 ],
 "meta": {
 }
 }
}

9.1.2 Sending a cypher statement (POST) to HugeGraphServer for synchronous execution

Method & Url

POST /graphs/{graph}/cypher

Params

graph: Graph name

Body

{cypher}

Authentication API

Mon, 01 Jan 0001 00:00:00 +0000

10.1 User Authentication and Access Control

To enable authentication and related configurations, please refer to the Authentication Configuration documentation.

Overview of User Authentication and Access Control:

HugeGraph supports multi-user authentication and fine-grained access control. It adopts a 4-tier design based on “User-User Group-Operation-Resource” to flexibly control user roles and permissions. Resources describe data in the graph database, such as vertices that meet certain conditions. Each resource consists of three elements: type, label, and properties. There are a total of 18 types and combinations of any label and properties to form resources. The internal condition of a resource is an “AND” relationship, while the condition between multiple resources is an “OR” relationship. Users can belong to one or more user groups, and each user group can have permissions for any number of resources. The types of operations include read, write, delete, execute, etc. HugeGraph supports dynamically creating users, user groups, and resources, and supports dynamically assigning or revoking permissions. During the initialization of the database, a super administrator user is created, and subsequently, various role users can be created by the super administrator. If a newly created user is assigned sufficient permissions, they can create or manage more users.

Metrics API

Mon, 01 Jan 0001 00:00:00 +0000

HugeGraph provides a metrics interface for obtaining monitoring information, such as statistics on each Gremlin execution time, cache size, etc. The metrics interface includes the following categories: basic metrics, statistical metrics, system metrics, and backend storage metrics.

1. Basic Metrics

1.1 Get All Basic Metrics

Params

type: If the passed value is json, it is returned in json format, otherwise it is returned in Promethaus format.

1.1.1 Method & Url

http://localhost:8080/metrics/?type=json

Response Status

Response Body

{
 "gauges": {
 "org.apache.hugegraph.backend.cache.Cache.edge-hugegraph.capacity": {
 "value": 1000000
 },
 "org.apache.hugegraph.backend.cache.Cache.edge-hugegraph.expire": {
 "value": 600000
 },
 "org.apache.hugegraph.backend.cache.Cache.edge-hugegraph.hits": {
 "value": 0
 },
 "org.apache.hugegraph.backend.cache.Cache.edge-hugegraph.miss": {
 "value": 0
 },
 "org.apache.hugegraph.backend.cache.Cache.edge-hugegraph.size": {
 "value": 0
 },
 "org.apache.hugegraph.backend.cache.Cache.instances": {
 "value": 7
 },
 "org.apache.hugegraph.backend.cache.Cache.schema-id-hugegraph.capacity": {
 "value": 10000
 },
 "org.apache.hugegraph.backend.cache.Cache.schema-id-hugegraph.expire": {
 "value": 0
 },
 "org.apache.hugegraph.backend.cache.Cache.schema-id-hugegraph.hits": {
 "value": 0
 },
 "org.apache.hugegraph.backend.cache.Cache.schema-id-hugegraph.miss": {
 "value": 0
 },
 "org.apache.hugegraph.backend.cache.Cache.schema-id-hugegraph.size": {
 "value": 17
 },
 "org.apache.hugegraph.backend.cache.Cache.schema-name-hugegraph.capacity": {
 "value": 10000
 },
 "org.apache.hugegraph.backend.cache.Cache.schema-name-hugegraph.expire": {
 "value": 0
 },
 "org.apache.hugegraph.backend.cache.Cache.schema-name-hugegraph.hits": {
 "value": 0
 },
 "org.apache.hugegraph.backend.cache.Cache.schema-name-hugegraph.miss": {
 "value": 0
 },
 "org.apache.hugegraph.backend.cache.Cache.schema-name-hugegraph.size": {
 "value": 17
 },
 "org.apache.hugegraph.backend.cache.Cache.token-hugegraph.capacity": {
 "value": 10240
 },
 "org.apache.hugegraph.backend.cache.Cache.token-hugegraph.expire": {
 "value": 600000
 },
 "org.apache.hugegraph.backend.cache.Cache.token-hugegraph.hits": {
 "value": 0
 },
 "org.apache.hugegraph.backend.cache.Cache.token-hugegraph.miss": {
 "value": 0
 },
 "org.apache.hugegraph.backend.cache.Cache.token-hugegraph.size": {
 "value": 0
 },
 "org.apache.hugegraph.backend.cache.Cache.users-hugegraph.capacity": {
 "value": 10240
 },
 "org.apache.hugegraph.backend.cache.Cache.users-hugegraph.expire": {
 "value": 600000
 },
 "org.apache.hugegraph.backend.cache.Cache.users-hugegraph.hits": {
 "value": 0
 },
 "org.apache.hugegraph.backend.cache.Cache.users-hugegraph.miss": {
 "value": 0
 },
 "org.apache.hugegraph.backend.cache.Cache.users-hugegraph.size": {
 "value": 0
 },
 "org.apache.hugegraph.backend.cache.Cache.users_pwd-hugegraph.capacity": {
 "value": 10240
 },
 "org.apache.hugegraph.backend.cache.Cache.users_pwd-hugegraph.expire": {
 "value": 600000
 },
 "org.apache.hugegraph.backend.cache.Cache.users_pwd-hugegraph.hits": {
 "value": 0
 },
 "org.apache.hugegraph.backend.cache.Cache.users_pwd-hugegraph.miss": {
 "value": 0
 },
 "org.apache.hugegraph.backend.cache.Cache.users_pwd-hugegraph.size": {
 "value": 0
 },
 "org.apache.hugegraph.backend.cache.Cache.vertex-hugegraph.capacity": {
 "value": 10000000
 },
 "org.apache.hugegraph.backend.cache.Cache.vertex-hugegraph.expire": {
 "value": 600000
 },
 "org.apache.hugegraph.backend.cache.Cache.vertex-hugegraph.hits": {
 "value": 0
 },
 "org.apache.hugegraph.backend.cache.Cache.vertex-hugegraph.miss": {
 "value": 0
 },
 "org.apache.hugegraph.backend.cache.Cache.vertex-hugegraph.size": {
 "value": 0
 },
 "org.apache.hugegraph.server.RestServer.max-write-threads": {
 "value": 0
 },
 "org.apache.hugegraph.task.TaskManager.pending-tasks": {
 "value": 0
 },
 "org.apache.hugegraph.task.TaskManager.workers": {
 "value": 4
 },
 "org.apache.tinkerpop.gremlin.server.GremlinServer.gremlin-groovy.sessionless.class-cache.average-load-penalty": {
 "value": 922769200
 },
 "org.apache.tinkerpop.gremlin.server.GremlinServer.gremlin-groovy.sessionless.class-cache.estimated-size": {
 "value": 2
 },
 "org.apache.tinkerpop.gremlin.server.GremlinServer.gremlin-groovy.sessionless.class-cache.eviction-count": {
 "value": 0
 },
 "org.apache.tinkerpop.gremlin.server.GremlinServer.gremlin-groovy.sessionless.class-cache.eviction-weight": {
 "value": 0
 },
 "org.apache.tinkerpop.gremlin.server.GremlinServer.gremlin-groovy.sessionless.class-cache.hit-count": {
 "value": 0
 },
 "org.apache.tinkerpop.gremlin.server.GremlinServer.gremlin-groovy.sessionless.class-cache.hit-rate": {
 "value": 0
 },
 "org.apache.tinkerpop.gremlin.server.GremlinServer.gremlin-groovy.sessionless.class-cache.load-count": {
 "value": 2
 },
 "org.apache.tinkerpop.gremlin.server.GremlinServer.gremlin-groovy.sessionless.class-cache.load-failure-count": {
 "value": 0
 },
 "org.apache.tinkerpop.gremlin.server.GremlinServer.gremlin-groovy.sessionless.class-cache.load-failure-rate": {
 "value": 0
 },
 "org.apache.tinkerpop.gremlin.server.GremlinServer.gremlin-groovy.sessionless.class-cache.load-success-count": {
 "value": 2
 },
 "org.apache.tinkerpop.gremlin.server.GremlinServer.gremlin-groovy.sessionless.class-cache.long-run-compilation-count": {
 "value": 0
 },
 "org.apache.tinkerpop.gremlin.server.GremlinServer.gremlin-groovy.sessionless.class-cache.miss-count": {
 "value": 2
 },
 "org.apache.tinkerpop.gremlin.server.GremlinServer.gremlin-groovy.sessionless.class-cache.miss-rate": {
 "value": 1
 },
 "org.apache.tinkerpop.gremlin.server.GremlinServer.gremlin-groovy.sessionless.class-cache.request-count": {
 "value": 2
 },
 "org.apache.tinkerpop.gremlin.server.GremlinServer.gremlin-groovy.sessionless.class-cache.total-load-time": {
 "value": 1845538400
 },
 "org.apache.tinkerpop.gremlin.server.GremlinServer.sessions": {
 "value": 0
 }
 },
 "counters": {
 "favicon.ico/GET/FAILED_COUNTER": {
 "count": 1
 },
 "favicon.ico/GET/TOTAL_COUNTER": {
 "count": 1
 },
 "metrics/POST/FAILED_COUNTER": {
 "count": 1
 },
 "metrics/POST/TOTAL_COUNTER": {
 "count": 1
 },
 "metrics/backend/GET/SUCCESS_COUNTER": {
 "count": 2
 },
 "metrics/backend/GET/TOTAL_COUNTER": {
 "count": 2
 },
 "metrics/gauges/GET/SUCCESS_COUNTER": {
 "count": 1
 },
 "metrics/gauges/GET/TOTAL_COUNTER": {
 "count": 1
 },
 "metrics/system/GET/SUCCESS_COUNTER": {
 "count": 2
 },
 "metrics/system/GET/TOTAL_COUNTER": {
 "count": 2
 },
 "system/GET/FAILED_COUNTER": {
 "count": 1
 },
 "system/GET/TOTAL_COUNTER": {
 "count": 1
 }
 },
 "histograms": {
 "favicon.ico/GET/RESPONSE_TIME_HISTOGRAM": {
 "count": 1,
 "min": 1,
 "mean": 1,
 "max": 1,
 "stddev": 0,
 "p50": 1,
 "p75": 1,
 "p95": 1,
 "p98": 1,
 "p99": 1,
 "p999": 1
 },
 "metrics/POST/RESPONSE_TIME_HISTOGRAM": {
 "count": 1,
 "min": 21,
 "mean": 21,
 "max": 21,
 "stddev": 0,
 "p50": 21,
 "p75": 21,
 "p95": 21,
 "p98": 21,
 "p99": 21,
 "p999": 21
 },
 "metrics/backend/GET/RESPONSE_TIME_HISTOGRAM": {
 "count": 2,
 "min": 6,
 "mean": 12.6852124529148,
 "max": 20,
 "stddev": 6.992918475157571,
 "p50": 6,
 "p75": 20,
 "p95": 20,
 "p98": 20,
 "p99": 20,
 "p999": 20
 },
 "metrics/gauges/GET/RESPONSE_TIME_HISTOGRAM": {
 "count": 1,
 "min": 7,
 "mean": 7,
 "max": 7,
 "stddev": 0,
 "p50": 7,
 "p75": 7,
 "p95": 7,
 "p98": 7,
 "p99": 7,
 "p999": 7
 },
 "metrics/system/GET/RESPONSE_TIME_HISTOGRAM": {
 "count": 2,
 "min": 0,
 "mean": 8.942674506664073,
 "max": 40,
 "stddev": 16.665399873223066,
 "p50": 0,
 "p75": 0,
 "p95": 40,
 "p98": 40,
 "p99": 40,
 "p999": 40
 },
 "system/GET/RESPONSE_TIME_HISTOGRAM": {
 "count": 1,
 "min": 2,
 "mean": 2,
 "max": 2,
 "stddev": 0,
 "p50": 2,
 "p75": 2,
 "p95": 2,
 "p98": 2,
 "p99": 2,
 "p999": 2
 }
 },
 "meters": {
 "org.apache.hugegraph.api.API.commit-succeed": {
 "count": 0,
 "mean_rate": 0,
 "m15_rate": 0,
 "m5_rate": 0,
 "m1_rate": 0,
 "rate_unit": "events/second"
 },
 "org.apache.hugegraph.api.API.expected-error": {
 "count": 0,
 "mean_rate": 0,
 "m15_rate": 0,
 "m5_rate": 0,
 "m1_rate": 0,
 "rate_unit": "events/second"
 },
 "org.apache.hugegraph.api.API.illegal-arg": {
 "count": 0,
 "mean_rate": 0,
 "m15_rate": 0,
 "m5_rate": 0,
 "m1_rate": 0,
 "rate_unit": "events/second"
 },
 "org.apache.hugegraph.api.API.unknown-error": {
 "count": 0,
 "mean_rate": 0,
 "m15_rate": 0,
 "m5_rate": 0,
 "m1_rate": 0,
 "rate_unit": "events/second"
 },
 "org.apache.tinkerpop.gremlin.server.GremlinServer.errors": {
 "count": 0,
 "mean_rate": 0,
 "m15_rate": 0,
 "m5_rate": 0,
 "m1_rate": 0,
 "rate_unit": "events/second"
 }
 },
 "timers": {
 "org.apache.hugegraph.api.auth.AccessAPI.create": {
 "count": 0,
 "min": 0,
 "mean": 0,
 "max": 0,
 "stddev": 0,
 "p50": 0,
 "p75": 0,
 "p95": 0,
 "p98": 0,
 "p99": 0,
 "p999": 0,
 "duration_unit": "milliseconds",
 "mean_rate": 0,
 "m15_rate": 0,
 "m5_rate": 0,
 "m1_rate": 0,
 "rate_unit": "calls/second"
 },
 "org.apache.hugegraph.api.auth.AccessAPI.delete": {
 "count": 0,
 "min": 0,
 "mean": 0,
 "max": 0,
 "stddev": 0,
 "p50": 0,
 "p75": 0,
 "p95": 0,
 "p98": 0,
 "p99": 0,
 "p999": 0,
 "duration_unit": "milliseconds",
 "mean_rate": 0,
 "m15_rate": 0,
 "m5_rate": 0,
 "m1_rate": 0,
 "rate_unit": "calls/second"
 },
 "org.apache.hugegraph.api.auth.AccessAPI.get": {
 "count": 0,
 "min": 0,
 "mean": 0,
 "max": 0,
 "stddev": 0,
 "p50": 0,
 "p75": 0,
 "p95": 0,
 "p98": 0,
 "p99": 0,
 "p999": 0,
 "duration_unit": "milliseconds",
 "mean_rate": 0,
 "m15_rate": 0,
 "m5_rate": 0,
 "m1_rate": 0,
 "rate_unit": "calls/second"
 },
 "org.apache.hugegraph.api.auth.AccessAPI.list": {
 "count": 0,
 "min": 0,
 "mean": 0,
 "max": 0,
 "stddev": 0,
 "p50": 0,
 "p75": 0,
 "p95": 0,
 "p98": 0,
 "p99": 0,
 "p999": 0,
 "duration_unit": "milliseconds",
 "mean_rate": 0,
 "m15_rate": 0,
 "m5_rate": 0,
 "m1_rate": 0,
 "rate_unit": "calls/second"
 },
 ...
 }
}

1.1.2 Method & Url

http://localhost:8080/metrics/

Response Status

Response Body

# HELP hugegraph_info
# TYPE hugegraph_info untyped
hugegraph_info{version="0.69",
} 1.0
# HELP org_apache_hugegraph_backend_cache_Cache_edge_hugegraph_capacity
# TYPE org_apache_hugegraph_backend_cache_Cache_edge_hugegraph_capacity gauge
org_apache_hugegraph_backend_cache_Cache_edge_hugegraph_capacity 1000000
# HELP org_apache_hugegraph_backend_cache_Cache_edge_hugegraph_expire
# TYPE org_apache_hugegraph_backend_cache_Cache_edge_hugegraph_expire gauge
org_apache_hugegraph_backend_cache_Cache_edge_hugegraph_expire 600000
# HELP org_apache_hugegraph_backend_cache_Cache_edge_hugegraph_hits
# TYPE org_apache_hugegraph_backend_cache_Cache_edge_hugegraph_hits gauge
org_apache_hugegraph_backend_cache_Cache_edge_hugegraph_hits 0
# HELP org_apache_hugegraph_backend_cache_Cache_edge_hugegraph_miss
# TYPE org_apache_hugegraph_backend_cache_Cache_edge_hugegraph_miss gauge
org_apache_hugegraph_backend_cache_Cache_edge_hugegraph_miss 0
# HELP org_apache_hugegraph_backend_cache_Cache_edge_hugegraph_size
# TYPE org_apache_hugegraph_backend_cache_Cache_edge_hugegraph_size gauge
org_apache_hugegraph_backend_cache_Cache_edge_hugegraph_size 0
# HELP org_apache_hugegraph_backend_cache_Cache_instances
# TYPE org_apache_hugegraph_backend_cache_Cache_instances gauge
org_apache_hugegraph_backend_cache_Cache_instances 7
# HELP org_apache_hugegraph_backend_cache_Cache_schema_id_hugegraph_capacity
# TYPE org_apache_hugegraph_backend_cache_Cache_schema_id_hugegraph_capacity gauge
org_apache_hugegraph_backend_cache_Cache_schema_id_hugegraph_capacity 10000
# HELP org_apache_hugegraph_backend_cache_Cache_schema_id_hugegraph_expire
# TYPE org_apache_hugegraph_backend_cache_Cache_schema_id_hugegraph_expire gauge
org_apache_hugegraph_backend_cache_Cache_schema_id_hugegraph_expire 0
# HELP org_apache_hugegraph_backend_cache_Cache_schema_id_hugegraph_hits
# TYPE org_apache_hugegraph_backend_cache_Cache_schema_id_hugegraph_hits gauge
org_apache_hugegraph_backend_cache_Cache_schema_id_hugegraph_hits 0
# HELP org_apache_hugegraph_backend_cache_Cache_schema_id_hugegraph_miss
# TYPE org_apache_hugegraph_backend_cache_Cache_schema_id_hugegraph_miss gauge
org_apache_hugegraph_backend_cache_Cache_schema_id_hugegraph_miss 0
# HELP org_apache_hugegraph_backend_cache_Cache_schema_id_hugegraph_size
# TYPE org_apache_hugegraph_backend_cache_Cache_schema_id_hugegraph_size gauge
org_apache_hugegraph_backend_cache_Cache_schema_id_hugegraph_size 17
# HELP org_apache_hugegraph_backend_cache_Cache_schema_name_hugegraph_capacity
# TYPE org_apache_hugegraph_backend_cache_Cache_schema_name_hugegraph_capacity gauge
org_apache_hugegraph_backend_cache_Cache_schema_name_hugegraph_capacity 10000
# HELP org_apache_hugegraph_backend_cache_Cache_schema_name_hugegraph_expire
# TYPE org_apache_hugegraph_backend_cache_Cache_schema_name_hugegraph_expire gauge
org_apache_hugegraph_backend_cache_Cache_schema_name_hugegraph_expire 0
# HELP org_apache_hugegraph_backend_cache_Cache_schema_name_hugegraph_hits
# TYPE org_apache_hugegraph_backend_cache_Cache_schema_name_hugegraph_hits gauge
org_apache_hugegraph_backend_cache_Cache_schema_name_hugegraph_hits 0
# HELP org_apache_hugegraph_backend_cache_Cache_schema_name_hugegraph_miss
# TYPE org_apache_hugegraph_backend_cache_Cache_schema_name_hugegraph_miss gauge
org_apache_hugegraph_backend_cache_Cache_schema_name_hugegraph_miss 0
# HELP org_apache_hugegraph_backend_cache_Cache_schema_name_hugegraph_size
# TYPE org_apache_hugegraph_backend_cache_Cache_schema_name_hugegraph_size gauge
org_apache_hugegraph_backend_cache_Cache_schema_name_hugegraph_size 17
...

1.2 Get Gauges Metrics

Method & Url

http://localhost:8080/metrics/gauges

Response Status

Response Body

{
 "org.apache.hugegraph.backend.cache.Cache.edge-hugegraph.capacity": {
 "value": 1000000
 },
 "org.apache.hugegraph.backend.cache.Cache.edge-hugegraph.expire": {
 "value": 600000
 },
 "org.apache.hugegraph.backend.cache.Cache.edge-hugegraph.hits": {
 "value": 0
 },
 "org.apache.hugegraph.backend.cache.Cache.edge-hugegraph.miss": {
 "value": 0
 },
 "org.apache.hugegraph.backend.cache.Cache.edge-hugegraph.size": {
 "value": 0
 },
 "org.apache.hugegraph.backend.cache.Cache.instances": {
 "value": 7
 },
 "org.apache.hugegraph.backend.cache.Cache.schema-id-hugegraph.capacity": {
 "value": 10000
 },
 "org.apache.hugegraph.backend.cache.Cache.schema-id-hugegraph.expire": {
 "value": 0
 },
 "org.apache.hugegraph.backend.cache.Cache.schema-id-hugegraph.hits": {
 "value": 0
 },
 "org.apache.hugegraph.backend.cache.Cache.schema-id-hugegraph.miss": {
 "value": 0
 },
 "org.apache.hugegraph.backend.cache.Cache.schema-id-hugegraph.size": {
 "value": 17
 },
 "org.apache.hugegraph.backend.cache.Cache.schema-name-hugegraph.capacity": {
 "value": 10000
 },
 "org.apache.hugegraph.backend.cache.Cache.schema-name-hugegraph.expire": {
 "value": 0
 },
 "org.apache.hugegraph.backend.cache.Cache.schema-name-hugegraph.hits": {
 "value": 0
 },
 "org.apache.hugegraph.backend.cache.Cache.schema-name-hugegraph.miss": {
 "value": 0
 },
 "org.apache.hugegraph.backend.cache.Cache.schema-name-hugegraph.size": {
 "value": 17
 },
 "org.apache.hugegraph.backend.cache.Cache.token-hugegraph.capacity": {
 "value": 10240
 },
 "org.apache.hugegraph.backend.cache.Cache.token-hugegraph.expire": {
 "value": 600000
 },
 "org.apache.hugegraph.backend.cache.Cache.token-hugegraph.hits": {
 "value": 0
 },
 "org.apache.hugegraph.backend.cache.Cache.token-hugegraph.miss": {
 "value": 0
 },
 "org.apache.hugegraph.backend.cache.Cache.token-hugegraph.size": {
 "value": 0
 },
 "org.apache.hugegraph.backend.cache.Cache.users-hugegraph.capacity": {
 "value": 10240
 },
 "org.apache.hugegraph.backend.cache.Cache.users-hugegraph.expire": {
 "value": 600000
 },
 "org.apache.hugegraph.backend.cache.Cache.users-hugegraph.hits": {
 "value": 0
 },
 "org.apache.hugegraph.backend.cache.Cache.users-hugegraph.miss": {
 "value": 0
 },
 "org.apache.hugegraph.backend.cache.Cache.users-hugegraph.size": {
 "value": 0
 },
 "org.apache.hugegraph.backend.cache.Cache.users_pwd-hugegraph.capacity": {
 "value": 10240
 },
 "org.apache.hugegraph.backend.cache.Cache.users_pwd-hugegraph.expire": {
 "value": 600000
 },
 "org.apache.hugegraph.backend.cache.Cache.users_pwd-hugegraph.hits": {
 "value": 0
 },
 "org.apache.hugegraph.backend.cache.Cache.users_pwd-hugegraph.miss": {
 "value": 0
 },
 "org.apache.hugegraph.backend.cache.Cache.users_pwd-hugegraph.size": {
 "value": 0
 },
 "org.apache.hugegraph.backend.cache.Cache.vertex-hugegraph.capacity": {
 "value": 10000000
 },
 "org.apache.hugegraph.backend.cache.Cache.vertex-hugegraph.expire": {
 "value": 600000
 },
 "org.apache.hugegraph.backend.cache.Cache.vertex-hugegraph.hits": {
 "value": 0
 },
 "org.apache.hugegraph.backend.cache.Cache.vertex-hugegraph.miss": {
 "value": 0
 },
 "org.apache.hugegraph.backend.cache.Cache.vertex-hugegraph.size": {
 "value": 0
 },
 "org.apache.hugegraph.server.RestServer.max-write-threads": {
 "value": 0
 },
 "org.apache.hugegraph.task.TaskManager.pending-tasks": {
 "value": 0
 },
 "org.apache.hugegraph.task.TaskManager.workers": {
 "value": 4
 },
 "org.apache.tinkerpop.gremlin.server.GremlinServer.gremlin-groovy.sessionless.class-cache.average-load-penalty": {
 "value": 9.227692E8
 },
 "org.apache.tinkerpop.gremlin.server.GremlinServer.gremlin-groovy.sessionless.class-cache.estimated-size": {
 "value": 2
 },
 "org.apache.tinkerpop.gremlin.server.GremlinServer.gremlin-groovy.sessionless.class-cache.eviction-count": {
 "value": 0
 },
 "org.apache.tinkerpop.gremlin.server.GremlinServer.gremlin-groovy.sessionless.class-cache.eviction-weight": {
 "value": 0
 },
 "org.apache.tinkerpop.gremlin.server.GremlinServer.gremlin-groovy.sessionless.class-cache.hit-count": {
 "value": 0
 },
 "org.apache.tinkerpop.gremlin.server.GremlinServer.gremlin-groovy.sessionless.class-cache.hit-rate": {
 "value": 0.0
 },
 "org.apache.tinkerpop.gremlin.server.GremlinServer.gremlin-groovy.sessionless.class-cache.load-count": {
 "value": 2
 },
 "org.apache.tinkerpop.gremlin.server.GremlinServer.gremlin-groovy.sessionless.class-cache.load-failure-count": {
 "value": 0
 },
 "org.apache.tinkerpop.gremlin.server.GremlinServer.gremlin-groovy.sessionless.class-cache.load-failure-rate": {
 "value": 0.0
 },
 "org.apache.tinkerpop.gremlin.server.GremlinServer.gremlin-groovy.sessionless.class-cache.load-success-count": {
 "value": 2
 },
 "org.apache.tinkerpop.gremlin.server.GremlinServer.gremlin-groovy.sessionless.class-cache.long-run-compilation-count": {
 "value": 0
 },
 "org.apache.tinkerpop.gremlin.server.GremlinServer.gremlin-groovy.sessionless.class-cache.miss-count": {
 "value": 2
 },
 "org.apache.tinkerpop.gremlin.server.GremlinServer.gremlin-groovy.sessionless.class-cache.miss-rate": {
 "value": 1.0
 },
 "org.apache.tinkerpop.gremlin.server.GremlinServer.gremlin-groovy.sessionless.class-cache.request-count": {
 "value": 2
 },
 "org.apache.tinkerpop.gremlin.server.GremlinServer.gremlin-groovy.sessionless.class-cache.total-load-time": {
 "value": 1845538400
 },
 "org.apache.tinkerpop.gremlin.server.GremlinServer.sessions": {
 "value": 0
 }
}

1.3 Get Counters Metrics

Method & Url

GET http://localhost:8080/metrics/counters

Response Status

Response Body

{
 "favicon.ico/GET/FAILED_COUNTER": {
 "count": 1
 },
 "favicon.ico/GET/TOTAL_COUNTER": {
 "count": 1
 },
 "metrics//GET/SUCCESS_COUNTER": {
 "count": 2
 },
 "metrics//GET/TOTAL_COUNTER": {
 "count": 2
 },
 "metrics/POST/FAILED_COUNTER": {
 "count": 1
 },
 "metrics/POST/TOTAL_COUNTER": {
 "count": 1
 },
 "metrics/backend/GET/SUCCESS_COUNTER": {
 "count": 2
 },
 "metrics/backend/GET/TOTAL_COUNTER": {
 "count": 2
 },
 "metrics/gauges/GET/SUCCESS_COUNTER": {
 "count": 1
 },
 "metrics/gauges/GET/TOTAL_COUNTER": {
 "count": 1
 },
 "metrics/statistics/GET/SUCCESS_COUNTER": {
 "count": 2
 },
 "metrics/statistics/GET/TOTAL_COUNTER": {
 "count": 2
 },
 "metrics/system/GET/SUCCESS_COUNTER": {
 "count": 2
 },
 "metrics/system/GET/TOTAL_COUNTER": {
 "count": 2
 },
 "metrics/timers/GET/SUCCESS_COUNTER": {
 "count": 1
 },
 "metrics/timers/GET/TOTAL_COUNTER": {
 "count": 1
 },
 "system/GET/FAILED_COUNTER": {
 "count": 1
 },
 "system/GET/TOTAL_COUNTER": {
 "count": 1
 }
}

1.4 Get Histograms Metrics

Method & Url

GET http://localhost:8080/metrics/gauges

Response Status

Response Body

{
 "favicon.ico/GET/RESPONSE_TIME_HISTOGRAM": {
 "count": 1,
 "min": 1,
 "mean": 1.0,
 "max": 1,
 "stddev": 0.0,
 "p50": 1.0,
 "p75": 1.0,
 "p95": 1.0,
 "p98": 1.0,
 "p99": 1.0,
 "p999": 1.0
 },
 "metrics//GET/RESPONSE_TIME_HISTOGRAM": {
 "count": 2,
 "min": 10,
 "mean": 10.0,
 "max": 10,
 "stddev": 0.0,
 "p50": 10.0,
 "p75": 10.0,
 "p95": 10.0,
 "p98": 10.0,
 "p99": 10.0,
 "p999": 10.0
 },
 "metrics/POST/RESPONSE_TIME_HISTOGRAM": {
 "count": 1,
 "min": 21,
 "mean": 21.0,
 "max": 21,
 "stddev": 0.0,
 "p50": 21.0,
 "p75": 21.0,
 "p95": 21.0,
 "p98": 21.0,
 "p99": 21.0,
 "p999": 21.0
 },
 "metrics/backend/GET/RESPONSE_TIME_HISTOGRAM": {
 "count": 2,
 "min": 6,
 "mean": 12.6852124529148,
 "max": 20,
 "stddev": 6.992918475157571,
 "p50": 6.0,
 "p75": 20.0,
 "p95": 20.0,
 "p98": 20.0,
 "p99": 20.0,
 "p999": 20.0
 },
 "metrics/gauges/GET/RESPONSE_TIME_HISTOGRAM": {
 "count": 1,
 "min": 7,
 "mean": 7.0,
 "max": 7,
 "stddev": 0.0,
 "p50": 7.0,
 "p75": 7.0,
 "p95": 7.0,
 "p98": 7.0,
 "p99": 7.0,
 "p999": 7.0
 },
 "metrics/statistics/GET/RESPONSE_TIME_HISTOGRAM": {
 "count": 2,
 "min": 1,
 "mean": 1.4551211076264199,
 "max": 2,
 "stddev": 0.49798181193626,
 "p50": 1.0,
 "p75": 2.0,
 "p95": 2.0,
 "p98": 2.0,
 "p99": 2.0,
 "p999": 2.0
 },
 "metrics/system/GET/RESPONSE_TIME_HISTOGRAM": {
 "count": 2,
 "min": 0,
 "mean": 8.942674506664073,
 "max": 40,
 "stddev": 16.665399873223066,
 "p50": 0.0,
 "p75": 0.0,
 "p95": 40.0,
 "p98": 40.0,
 "p99": 40.0,
 "p999": 40.0
 },
 "metrics/timers/GET/RESPONSE_TIME_HISTOGRAM": {
 "count": 1,
 "min": 3,
 "mean": 3.0,
 "max": 3,
 "stddev": 0.0,
 "p50": 3.0,
 "p75": 3.0,
 "p95": 3.0,
 "p98": 3.0,
 "p99": 3.0,
 "p999": 3.0
 },
 "system/GET/RESPONSE_TIME_HISTOGRAM": {
 "count": 1,
 "min": 2,
 "mean": 2.0,
 "max": 2,
 "stddev": 0.0,
 "p50": 2.0,
 "p75": 2.0,
 "p95": 2.0,
 "p98": 2.0,
 "p99": 2.0,
 "p999": 2.0
 }
}

1.5 Get Meters Metrics

Method & Url

GET http://localhost:8080/metrics/meters

Response Status

Response Body

{
 "org.apache.hugegraph.api.API.commit-succeed": {
 "count": 0,
 "mean_rate": 0.0,
 "m15_rate": 0.0,
 "m5_rate": 0.0,
 "m1_rate": 0.0,
 "rate_unit": "events/second"
 },
 "org.apache.hugegraph.api.API.expected-error": {
 "count": 0,
 "mean_rate": 0.0,
 "m15_rate": 0.0,
 "m5_rate": 0.0,
 "m1_rate": 0.0,
 "rate_unit": "events/second"
 },
 "org.apache.hugegraph.api.API.illegal-arg": {
 "count": 0,
 "mean_rate": 0.0,
 "m15_rate": 0.0,
 "m5_rate": 0.0,
 "m1_rate": 0.0,
 "rate_unit": "events/second"
 },
 "org.apache.hugegraph.api.API.unknown-error": {
 "count": 0,
 "mean_rate": 0.0,
 "m15_rate": 0.0,
 "m5_rate": 0.0,
 "m1_rate": 0.0,
 "rate_unit": "events/second"
 },
 "org.apache.tinkerpop.gremlin.server.GremlinServer.errors": {
 "count": 0,
 "mean_rate": 0.0,
 "m15_rate": 0.0,
 "m5_rate": 0.0,
 "m1_rate": 0.0,
 "rate_unit": "events/second"
 }
}

1.6 Get Timers Metrics

Method & Url

GET http://localhost:8080/metrics/timers

Response Status

Response Body

{
 "org.apache.hugegraph.api.auth.AccessAPI.create": {
 "count": 0,
 "min": 0.0,
 "mean": 0.0,
 "max": 0.0,
 "stddev": 0.0,
 "p50": 0.0,
 "p75": 0.0,
 "p95": 0.0,
 "p98": 0.0,
 "p99": 0.0,
 "p999": 0.0,
 "duration_unit": "milliseconds",
 "mean_rate": 0.0,
 "m15_rate": 0.0,
 "m5_rate": 0.0,
 "m1_rate": 0.0,
 "rate_unit": "calls/second"
 },
 "org.apache.hugegraph.api.auth.AccessAPI.delete": {
 "count": 0,
 "min": 0.0,
 "mean": 0.0,
 "max": 0.0,
 "stddev": 0.0,
 "p50": 0.0,
 "p75": 0.0,
 "p95": 0.0,
 "p98": 0.0,
 "p99": 0.0,
 "p999": 0.0,
 "duration_unit": "milliseconds",
 "mean_rate": 0.0,
 "m15_rate": 0.0,
 "m5_rate": 0.0,
 "m1_rate": 0.0,
 "rate_unit": "calls/second"
 },
 ...
}

2.Statistical Metrics

Params

type: If the passed value is JSON, it is returned in JSON format, otherwise it is returned in Promethaus format.

2.1 Method & Url

GET http://localhost:8080/metrics/statistics

Response Status

# HELP hugegraph_info
# TYPE hugegraph_info untyped
hugegraph_info{version="0.69",
} 1.0
# HELP metrics_POST
# TYPE metrics_POST gauge
metrics_POST{name=FAILED_REQUEST,} 1
metrics_POST{name=MEAN_RESPONSE_TIME,} 21.0
metrics_POST{
name=MAX_RESPONSE_TIME,
} 21
metrics_POST{name=SUCCESS_REQUEST,
} 0
metrics_POST{
name=TOTAL_REQUEST,
} 1
# HELP metrics_backend_GET
# TYPE metrics_backend_GET gauge
metrics_backend_GET{name=FAILED_REQUEST,
} 0
metrics_backend_GET{
name=MEAN_RESPONSE_TIME,
} 12.6852124529148
metrics_backend_GET{
name=MAX_RESPONSE_TIME,
} 20
metrics_backend_GET{
name=SUCCESS_REQUEST,
} 2
metrics_backend_GET{name=TOTAL_REQUEST,} 2
# HELP system_GET
# TYPE system_GET gauge
system_GET{name=FAILED_REQUEST,} 1
system_GET{name=MEAN_RESPONSE_TIME,} 2.0
system_GET{name=MAX_RESPONSE_TIME,} 2
system_GET{
name=SUCCESS_REQUEST,
} 0
system_GET{name=TOTAL_REQUEST,
} 1
# HELP metrics_gauges_GET
# TYPE metrics_gauges_GET gauge
metrics_gauges_GET{name=FAILED_REQUEST,} 0
metrics_gauges_GET{name=MEAN_RESPONSE_TIME,
} 7.0
metrics_gauges_GET{
name=MAX_RESPONSE_TIME,
} 7
metrics_gauges_GET{
name=SUCCESS_REQUEST,
} 1
metrics_gauges_GET{
name=TOTAL_REQUEST,
} 1
# HELP favicon.ico_GET
# TYPE favicon.ico_GET gauge
favicon.ico_GET{name=FAILED_REQUEST,
} 1
favicon.ico_GET{
name=MEAN_RESPONSE_TIME,
} 1.0
favicon.ico_GET{name=MAX_RESPONSE_TIME,} 1
favicon.ico_GET{name=SUCCESS_REQUEST,} 0
favicon.ico_GET{
name=TOTAL_REQUEST,
} 1
# HELP metrics__GET
# TYPE metrics__GET gauge
metrics__GET{name=FAILED_REQUEST,} 0
metrics__GET{name=MEAN_RESPONSE_TIME,} 10.0
metrics__GET{name=MAX_RESPONSE_TIME,
} 10
metrics__GET{
name=SUCCESS_REQUEST,
} 2
metrics__GET{
name=TOTAL_REQUEST,
} 2
# HELP metrics_system_GET
# TYPE metrics_system_GET gauge
metrics_system_GET{name=FAILED_REQUEST,} 0
metrics_system_GET{name=MEAN_RESPONSE_TIME,
} 8.942674506664073
metrics_system_GET{
name=MAX_RESPONSE_TIME,
} 40
metrics_system_GET{name=SUCCESS_REQUEST,} 2
metrics_system_GET{name=TOTAL_REQUEST,
} 2

Response Body

2.2 Method & Url

GET http://localhost:8080/metrics/statistics?type=json

Response Status

Response Body

{
 "metrics/POST": {
 "FAILED_REQUEST": 1,
 "MEAN_RESPONSE_TIME": 21,
 "MAX_RESPONSE_TIME": 21,
 "SUCCESS_REQUEST": 0,
 "TOTAL_REQUEST": 1
 },
 "metrics/backend/GET": {
 "FAILED_REQUEST": 0,
 "MEAN_RESPONSE_TIME": 12.6852124529148,
 "MAX_RESPONSE_TIME": 20,
 "SUCCESS_REQUEST": 2,
 "TOTAL_REQUEST": 2
 },
 "system/GET": {
 "FAILED_REQUEST": 1,
 "MEAN_RESPONSE_TIME": 2,
 "MAX_RESPONSE_TIME": 2,
 "SUCCESS_REQUEST": 0,
 "TOTAL_REQUEST": 1
 },
 "metrics/gauges/GET": {
 "FAILED_REQUEST": 0,
 "MEAN_RESPONSE_TIME": 7,
 "MAX_RESPONSE_TIME": 7,
 "SUCCESS_REQUEST": 1,
 "TOTAL_REQUEST": 1
 },
 "favicon.ico/GET": {
 "FAILED_REQUEST": 1,
 "MEAN_RESPONSE_TIME": 1,
 "MAX_RESPONSE_TIME": 1,
 "SUCCESS_REQUEST": 0,
 "TOTAL_REQUEST": 1
 },
 "metrics//GET": {
 "FAILED_REQUEST": 0,
 "MEAN_RESPONSE_TIME": 10,
 "MAX_RESPONSE_TIME": 10,
 "SUCCESS_REQUEST": 2,
 "TOTAL_REQUEST": 2
 },
 "metrics/system/GET": {
 "FAILED_REQUEST": 0,
 "MEAN_RESPONSE_TIME": 8.942674506664073,
 "MAX_RESPONSE_TIME": 40,
 "SUCCESS_REQUEST": 2,
 "TOTAL_REQUEST": 2
 }
}

3.System Metrics

System metrics mainly return the machine metrics, such as memory, threads, and other information.

Other API

Mon, 01 Jan 0001 00:00:00 +0000

11.1 Other

11.1.1 View Version Information of HugeGraph

Method & Url

GET http://localhost:8080/versions

Response Status

Response Body

{
 "versions": {
 "version": "v1",
 "core": "0.4.5.1",
 "gremlin": "3.2.5",
 "api": "0.13.2.0"
 }
}