Merge pull request #466 from monicasarbu/actual_used_free_docs

Update all actual_used and actual_free fields
elastic · Dec 10, 2015 · 8b02749 · 8b02749
2 parents 1601d90 + 7b71d60
commit 8b02749
Show file tree

Hide file tree

Showing 6 changed files with 26 additions and 33 deletions.
diff --git a/topbeat/beat/sigar.go b/topbeat/beat/sigar.go
@@ -36,6 +36,13 @@ type MemStat struct {
 	ActualUsedPercent float64 `json:"actual_used_p"`
 }
 
+type SwapStat struct {
+	Total       uint64  `json:"total"`
+	Used        uint64  `json:"used"`
+	Free        uint64  `json:"free"`
+	UsedPercent float64 `json:"used_p"`
+}
+
 type ProcMemStat struct {
 	Size       uint64  `json:"size"`
 	Rss        uint64  `json:"rss"`
@@ -191,15 +198,15 @@ func GetMemory() (*MemStat, error) {
 	}, nil
 }
 
-func GetSwap() (*MemStat, error) {
+func GetSwap() (*SwapStat, error) {
 
 	swap := sigar.Swap{}
 	err := swap.Get()
 	if err != nil {
 		return nil, err
 	}
 
-	return &MemStat{
+	return &SwapStat{
 		Total: swap.Total,
 		Used:  swap.Used,
 		Free:  swap.Free,

diff --git a/topbeat/beat/topbeat.go b/topbeat/beat/topbeat.go
@@ -252,7 +252,7 @@ func (t *Topbeat) exportSystemStats() error {
 		logp.Warn("Getting swap details: %v", err)
 		return err
 	}
-	t.addMemPercentage(swap_stat)
+	t.addSwapPercentage(swap_stat)
 
 	event := common.MapStr{
 		"@timestamp": common.Time(time.Now()),
@@ -327,6 +327,15 @@ func (t *Topbeat) addMemPercentage(m *MemStat) {
 	m.ActualUsedPercent = Round(actual_perc, .5, 2)
 }
 
+func (t *Topbeat) addSwapPercentage(s *SwapStat) {
+	if s.Total == 0 {
+		return
+	}
+
+	perc := float64(s.Used) / float64(s.Total)
+	s.UsedPercent = Round(perc, .5, 2)
+}
+
 func addFileSystemUsedPercentage(f *FileSystemStat) {
 	if f.Total == 0 {
 		return

diff --git a/topbeat/docs/fields.asciidoc b/topbeat/docs/fields.asciidoc
@@ -206,14 +206,14 @@ The percentage of used memory.
 
 type: int
 
-Actual used memory. Available only on Unix.
+Actual used memory. It is defined as the "used" memory minus the memory used for disk caches and buffers.  Available only on Unix.
 
 
 ==== mem.actual_free
 
 type: int
 
-Actual available memory. Available only on Unix.
+Actual available memory. It is defined as the "free" memory plus the memory used for disk caches and buffers. Available only on Unix.
 
 
 ==== mem.actual_used_p

diff --git a/topbeat/etc/fields.yml b/topbeat/etc/fields.yml
@@ -176,13 +176,15 @@ system:
           path: mem.actual_used
           type: int
           description: >
-            Actual used memory. Available only on Unix.
+            Actual used memory. It is defined as the "used" memory minus the memory used for disk caches and buffers. 
+            Available only on Unix.
 
         - name: actual_free
           path: mem.actual_free
           type: int
           description: >
-            Actual available memory. Available only on Unix.
+            Actual available memory. It is defined as the "free" memory plus the memory used for disk caches and
+            buffers. Available only on Unix.
 
         - name: actual_used_p
           path: mem.actual_used_p
@@ -218,24 +220,6 @@ system:
           description: >
             The percentage of used swap memory.
 
-        - name: actual_used
-          path: swap.actual_used
-          type: int
-          description: >
-            Actual used swap memory. Available only on Unix.
-
-        - name: actual_free
-          path: swap.actual_free
-          type: int
-          description: >
-            Actual available swap memory. Available only on Unix.
-
-        - name: actual_used_p
-          path: swap.actual_used_p
-          type: float
-          description: >
-            The percentage of actual used swap memory.
-
 process:
   type: group
   description: >

diff --git a/topbeat/etc/topbeat.template.json b/topbeat/etc/topbeat.template.json
@@ -94,10 +94,6 @@
         },
         "swap": {
           "properties": {
-            "actual_used_p": {
-              "doc_values": "true",
-              "type": "float"
-            },
             "used_p": {
               "doc_values": "true",
               "type": "float"
@@ -111,4 +107,4 @@
     "index.refresh_interval": "5s"
   },
   "template": "topbeat-*"
-}
+}
diff --git a/topbeat/tests/system/test_system.py b/topbeat/tests/system/test_system.py
@@ -33,7 +33,6 @@ def test_system_wide(self):
             "mem.used_p",
             "mem.actual_used_p",
             "swap.used_p",
-            "swap.actual_used_p",
         ]:
             assert type(output[key]) in [float, int]
 
@@ -54,7 +53,5 @@ def test_system_wide(self):
             "swap.total",
             "swap.used",
             "swap.free",
-            "swap.actual_used",
-            "swap.actual_free",
         ]:
             assert type(output[key]) is int or type(output[key]) is long