summaryrefslogtreecommitdiffstats
path: root/infra/footprint/footprint-api
diff options
context:
space:
mode:
Diffstat (limited to 'infra/footprint/footprint-api')
-rw-r--r--infra/footprint/footprint-api/asciidoc/Readme.adoc3
-rw-r--r--infra/footprint/footprint-api/pom.xml34
-rw-r--r--infra/footprint/footprint-api/src/main/yang/footprint.yang28
3 files changed, 65 insertions, 0 deletions
diff --git a/infra/footprint/footprint-api/asciidoc/Readme.adoc b/infra/footprint/footprint-api/asciidoc/Readme.adoc
new file mode 100644
index 000000000..45c884491
--- /dev/null
+++ b/infra/footprint/footprint-api/asciidoc/Readme.adoc
@@ -0,0 +1,3 @@
+= api
+
+Provides api for reading honeycomb memory footprint. \ No newline at end of file
diff --git a/infra/footprint/footprint-api/pom.xml b/infra/footprint/footprint-api/pom.xml
new file mode 100644
index 000000000..cd9347a0d
--- /dev/null
+++ b/infra/footprint/footprint-api/pom.xml
@@ -0,0 +1,34 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!--
+ ~ Copyright (c) 2017 Cisco and/or its affiliates.
+ ~
+ ~ Licensed under the Apache License, Version 2.0 (the "License");
+ ~ you may not use this file except in compliance with the License.
+ ~ You may obtain a copy of the License at:
+ ~
+ ~ http://www.apache.org/licenses/LICENSE-2.0
+ ~
+ ~ Unless required by applicable law or agreed to in writing, software
+ ~ distributed under the License is distributed on an "AS IS" BASIS,
+ ~ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ ~ See the License for the specific language governing permissions and
+ ~ limitations under the License.
+ -->
+
+<project xmlns="http://maven.apache.org/POM/4.0.0"
+ xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+ xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
+ <parent>
+ <groupId>io.fd.honeycomb.common</groupId>
+ <artifactId>api-parent</artifactId>
+ <version>1.17.10-SNAPSHOT</version>
+ <relativePath>../../../common/api-parent</relativePath>
+ </parent>
+ <modelVersion>4.0.0</modelVersion>
+
+ <groupId>io.fd.honeycomb.footprint</groupId>
+ <artifactId>api</artifactId>
+ <version>1.17.10-SNAPSHOT</version>
+ <name>${project.artifactId}</name>
+ <packaging>jar</packaging>
+</project> \ No newline at end of file
diff --git a/infra/footprint/footprint-api/src/main/yang/footprint.yang b/infra/footprint/footprint-api/src/main/yang/footprint.yang
new file mode 100644
index 000000000..680f15c2a
--- /dev/null
+++ b/infra/footprint/footprint-api/src/main/yang/footprint.yang
@@ -0,0 +1,28 @@
+module footprint {
+ yang-version 1;
+ namespace "urn:opendaylight:params:xml:ns:yang:footprint";
+ prefix "footprint";
+
+ revision "2017-08-30" {
+ description "HC model for requesting current memory consumption";
+ }
+
+ container memory-footprint-state {
+ config false;
+
+ leaf footprint {
+ type uint32;
+ description "Memory footprint in kilobytes. Footprint is parsed as output of ps command, where RSS field is
+ read.
+
+ RSS is the Resident Set Size and is used to show how much memory is allocated to that process and is in RAM.
+ It does not include memory that is swapped out. It does include memory from shared libraries
+ as long as the pages from those libraries are actually in memory. It does include all stack and heap memory.";
+ }
+
+ leaf pid {
+ type uint32;
+ description "Process id of honeycomb";
+ }
+ }
+}