aboutsummaryrefslogtreecommitdiffstats
path: root/docs/index.rst
blob: 8f80b559c5fbca05086dd8a03d6c8298350f1af2 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
.. This work is licensed under a Creative Commons Attribution 4.0 International License.
.. http://creativecommons.org/licenses/by/4.0
.. (c) OPNFV, Intel Corporation and others.

=========
Barometer
=========

:Project: `Barometer`_


:Authors: Maryam Tahhan <maryam.tahhan@intel.com>

:History:

          ========== =====================================================
           Date       Description
          ========== =====================================================
          16.12.2014 Project creation
          ========== =====================================================

Barometer is the project that renames Software Fastpath service Quality Metrics
(SFQM) and updates its scope which was networking centric.

The goal of SFQM was to develop the utilities and libraries in DPDK to
support:

* Measuring Telco Traffic and Performance KPIs. Including:

  * Packet Delay Variation (by enabling TX and RX time stamping).
  * Packet loss (by exposing extended NIC stats).

* Performance Monitoring of the DPDK interfaces (by exposing
  extended NIC stats + collectd Plugin).
* Detecting and reporting violations that can be consumed by VNFs
  and higher level management systems (through DPDK Keep Alive).

With Barometer the scope is extended to monitoring the NFVI. The ability to
monitor the Network Function Virtualization Infrastructure (NFVI) where VNFs
are in operation will be a key part of Service Assurance within an NFV
environment, in order to enforce SLAs or to detect violations, faults or
degradation in the performance of NFVI resources so that events and relevant
metrics are reported to higher level fault management systems.
If physical appliances are going to be replaced by virtualized appliances
the service levels, manageability and service assurance needs to remain
consistent or improve on what is available today. As such, the NFVI needs to
support the ability to monitor:

* Traffic monitoring and performance monitoring of the components that provide
  networking functionality to the VNF, including: physical interfaces, virtual
  switch interfaces and flows, as well as the virtual interfaces themselves and
  their status, etc.
* Platform monitoring including: CPU, memory, load, cache, themals, fan speeds,
  voltages and machine check exceptions, etc.

All of the statistics and events gathered must be collected in-service and must
be capable of being reported by standard Telco mechanisms (e.g. SNMP), for
potential enforcement or correction actions. In addition, this information
could be fed to analytics systems to enable failure prediction, and can also be
used for intelligent workload placement.

All developed features will be upstreamed to Open Source projects relevant to
telemetry such as `collectd`_, and relevant Openstack projects.

.. toctree::
     :maxdepth: 3

     ./release/configguide/index.rst
     ./release/scenarios/index.rst
     ./release/userguide/index.rst
     ./release/release-notes/index.rst
     ./development/requirements/index.rst
     ./development/design/index.rst
     ./development/testing/index.rst

Indices
=======
* :ref:`search`

.. _Barometer: https://wiki.opnfv.org/display/fastpath
.. _collectd: http://collectd.org/
/a> 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680
{
  "dashboard": {
    "annotations": {
      "list": [
        {
          "builtIn": 1,
          "datasource": "-- Grafana --",
          "enable": true,
          "hide": true,
          "iconColor": "rgba(0, 211, 255, 1)",
          "name": "Annotations & Alerts",
          "type": "dashboard"
        }
      ]
    },
    "editable": true,
    "gnetId": null,
    "graphTooltip": 0,
    "hideControls": false,
    "id": null,
    "links": [],
    "refresh": "5s",
    "rows": [
      {
        "collapse": false,
        "height": 250,
        "panels": [
          {
            "cacheTimeout": null,
            "colorBackground": false,
            "colorValue": false,
            "colors": [
              "#d44a3a",
              "rgba(237, 129, 40, 0.89)",
              "#299c46"
            ],
            "datasource": "collectd",
            "format": "none",
            "gauge": {
              "maxValue": null,
              "minValue": 0,
              "show": false,
              "thresholdLabels": false,
              "thresholdMarkers": false
            },
            "id": 3,
            "interval": null,
            "links": [],
            "mappingType": 1,
            "mappingTypes": [
              {
                "name": "value to text",
                "value": 1
              },
              {
                "name": "range to text",
                "value": 2
              }
            ],
            "maxDataPoints": 100,
            "nullPointMode": "connected",
            "nullText": null,
            "postfix": "",
            "postfixFontSize": "50%",
            "prefix": "",
            "prefixFontSize": "50%",
            "rangeMaps": [
              {
                "from": "null",
                "text": "N/A",
                "to": "null"
              }
            ],
            "span": 3,
            "sparkline": {
              "fillColor": "rgba(31, 118, 189, 0.18)",
              "full": false,
              "lineColor": "rgb(31, 120, 193)",
              "show": false
            },
            "tableColumn": "",
            "targets": [
              {
                "alias": "$tag_instance",
                "dsType": "influxdb",
                "groupBy": [
                  {
                    "params": [
                      "$__interval"
                    ],
                    "type": "time"
                  },
                  {
                    "params": [
                      "null"
                    ],
                    "type": "fill"
                  }
                ],
                "measurement": "hugepages_value",
                "orderByTime": "ASC",
                "policy": "default",
                "refId": "A",
                "resultFormat": "time_series",
                "select": [
                  [
                    {
                      "params": [
                        "value"
                      ],
                      "type": "field"
                    },
                    {
                      "params": [],
                      "type": "mean"
                    }
                  ]
                ],
                "tags": [
                  {
                    "key": "host",
                    "operator": "=~",
                    "value": "/^$Host$/"
                  },
                  {
                    "condition": "AND",
                    "key": "type",
                    "operator": "=",
                    "value": "vmpage_number"
                  },
                  {
                    "condition": "AND",
                    "key": "type_instance",
                    "operator": "=",
                    "value": "free"
                  },
                  {
                    "condition": "AND",
                    "key": "instance",
                    "operator": "=~",
                    "value": "/^$instance$/"
                  }
                ]
              }
            ],
            "thresholds": "",
            "title": "Free hugepages on selected instance",
            "transparent": true,
            "type": "singlestat",
            "valueFontSize": "80%",
            "valueMaps": [
              {
                "op": "=",
                "text": "N/A",
                "value": "null"
              }
            ],
            "valueName": "current"
          },
          {
            "cacheTimeout": null,
            "colorBackground": false,
            "colorValue": false,
            "colors": [
              "#299c46",
              "rgba(237, 129, 40, 0.89)",
              "#d44a3a"
            ],
            "datasource": "collectd",
            "format": "none",
            "gauge": {
              "maxValue": 100,
              "minValue": 0,
              "show": false,
              "thresholdLabels": false,
              "thresholdMarkers": true
            },
            "id": 4,
            "interval": null,
            "links": [],
            "mappingType": 1,
            "mappingTypes": [
              {
                "name": "value to text",
                "value": 1
              },
              {
                "name": "range to text",
                "value": 2
              }
            ],
            "maxDataPoints": 100,
            "nullPointMode": "connected",
            "nullText": null,
            "postfix": "",
            "postfixFontSize": "50%",
            "prefix": "",
            "prefixFontSize": "50%",
            "rangeMaps": [
              {
                "from": "null",
                "text": "N/A",
                "to": "null"
              }
            ],
            "span": 3,
            "sparkline": {
              "fillColor": "rgba(31, 118, 189, 0.18)",
              "full": false,
              "lineColor": "rgb(31, 120, 193)",
              "show": false
            },
            "tableColumn": "",
            "targets": [
              {
                "alias": "$tag_instance",
                "dsType": "influxdb",
                "groupBy": [
                  {
                    "params": [
                      "$__interval"
                    ],
                    "type": "time"
                  },
                  {
                    "params": [
                      "null"
                    ],
                    "type": "fill"
                  }
                ],
                "measurement": "hugepages_value",
                "orderByTime": "ASC",
                "policy": "default",
                "refId": "A",
                "resultFormat": "time_series",
                "select": [
                  [
                    {
                      "params": [
                        "value"
                      ],
                      "type": "field"
                    },
                    {
                      "params": [],
                      "type": "mean"
                    }
                  ]
                ],
                "tags": [
                  {
                    "key": "host",
                    "operator": "=~",
                    "value": "/^$Host$/"
                  },
                  {
                    "condition": "AND",
                    "key": "type",
                    "operator": "=",
                    "value": "vmpage_number"
                  },
                  {
                    "condition": "AND",
                    "key": "instance",
                    "operator": "=~",
                    "value": "/^$instance$/"
                  },
                  {
                    "condition": "AND",
                    "key": "type_instance",
                    "operator": "=",
                    "value": "used"
                  }
                ]
              }
            ],
            "thresholds": "",
            "title": "Used hugepages on selected instance",
            "transparent": true,
            "type": "singlestat",
            "valueFontSize": "80%",
            "valueMaps": [
              {
                "op": "=",
                "text": "N/A",
                "value": "null"
              }
            ],
            "valueName": "current"
          }
        ],
        "repeat": null,
        "repeatIteration": null,
        "repeatRowId": null,
        "showTitle": true,
        "title": "VM Page Number",
        "titleSize": "h6"
      },
      {
        "collapse": false,
        "height": 250,
        "panels": [
          {
            "cacheTimeout": null,
            "colorBackground": false,
            "colorValue": false,
            "colors": [
              "#299c46",
              "rgba(237, 129, 40, 0.89)",
              "#d44a3a"
            ],
            "datasource": "collectd",
            "format": "none",
            "gauge": {
              "maxValue": 100,
              "minValue": 0,
              "show": false,
              "thresholdLabels": false,
              "thresholdMarkers": true
            },
            "id": 1,
            "interval": null,
            "links": [],
            "mappingType": 1,
            "mappingTypes": [
              {
                "name": "value to text",
                "value": 1
              },
              {
                "name": "range to text",
                "value": 2
              }
            ],
            "maxDataPoints": 100,
            "nullPointMode": "connected",
            "nullText": null,
            "postfix": "",
            "postfixFontSize": "50%",
            "prefix": "",
            "prefixFontSize": "50%",
            "rangeMaps": [
              {
                "from": "null",
                "text": "N/A",
                "to": "null"
              }
            ],
            "span": 3,
            "sparkline": {
              "fillColor": "rgba(31, 118, 189, 0.18)",
              "full": false,
              "lineColor": "rgb(31, 120, 193)",
              "show": false
            },
            "tableColumn": "",
            "targets": [
              {
                "dsType": "influxdb",
                "groupBy": [
                  {
                    "params": [
                      "$__interval"
                    ],
                    "type": "time"
                  },
                  {
                    "params": [
                      "null"
                    ],
                    "type": "fill"
                  }
                ],
                "measurement": "hugepages_value",
                "orderByTime": "ASC",
                "policy": "default",
                "refId": "A",
                "resultFormat": "time_series",
                "select": [
                  [
                    {
                      "params": [
                        "value"
                      ],
                      "type": "field"
                    },
                    {
                      "params": [],
                      "type": "mean"
                    }
                  ]
                ],
                "tags": [
                  {
                    "key": "host",
                    "operator": "=~",
                    "value": "/^$Host$/"
                  },
                  {
                    "condition": "AND",
                    "key": "type",
                    "operator": "=",
                    "value": "memory"
                  },
                  {
                    "condition": "AND",
                    "key": "instance",
                    "operator": "=~",
                    "value": "/^$instance$/"
                  },
                  {
                    "condition": "AND",
                    "key": "type_instance",
                    "operator": "=",
                    "value": "free"
                  }
                ]
              }
            ],
            "thresholds": "",
            "title": "Free hugepages on the system",
            "transparent": true,
            "type": "singlestat",
            "valueFontSize": "80%",
            "valueMaps": [
              {
                "op": "=",
                "text": "N/A",
                "value": "null"
              }
            ],
            "valueName": "current"
          },
          {
            "cacheTimeout": null,
            "colorBackground": false,
            "colorValue": false,
            "colors": [
              "#299c46",
              "rgba(237, 129, 40, 0.89)",
              "#d44a3a"
            ],
            "datasource": "collectd",
            "format": "none",
            "gauge": {
              "maxValue": 100,
              "minValue": 0,
              "show": false,
              "thresholdLabels": false,
              "thresholdMarkers": true
            },
            "id": 2,
            "interval": null,
            "links": [],
            "mappingType": 1,
            "mappingTypes": [
              {
                "name": "value to text",
                "value": 1
              },
              {
                "name": "range to text",
                "value": 2
              }
            ],
            "maxDataPoints": 100,
            "nullPointMode": "connected",
            "nullText": null,
            "postfix": "",
            "postfixFontSize": "50%",
            "prefix": "",
            "prefixFontSize": "50%",
            "rangeMaps": [
              {
                "from": "null",
                "text": "N/A",
                "to": "null"
              }
            ],
            "span": 3,
            "sparkline": {
              "fillColor": "rgba(31, 118, 189, 0.18)",
              "full": false,
              "lineColor": "rgb(31, 120, 193)",
              "show": false
            },
            "tableColumn": "",
            "targets": [
              {
                "dsType": "influxdb",
                "groupBy": [
                  {
                    "params": [
                      "$__interval"
                    ],
                    "type": "time"
                  },
                  {
                    "params": [
                      "null"
                    ],
                    "type": "fill"
                  }
                ],
                "measurement": "hugepages_value",
                "orderByTime": "ASC",
                "policy": "default",
                "refId": "A",
                "resultFormat": "time_series",
                "select": [
                  [
                    {
                      "params": [
                        "value"
                      ],
                      "type": "field"
                    },
                    {
                      "params": [],
                      "type": "mean"
                    }
                  ]
                ],
                "tags": [
                  {
                    "key": "host",
                    "operator": "=~",
                    "value": "/^$Host$/"
                  },
                  {
                    "condition": "AND",
                    "key": "type",
                    "operator": "=",
                    "value": "memory"
                  },
                  {
                    "condition": "AND",
                    "key": "instance",
                    "operator": "=~",
                    "value": "/^$instance$/"
                  },
                  {
                    "condition": "AND",
                    "key": "type_instance",
                    "operator": "=",
                    "value": "used"
                  }
                ]
              }
            ],
            "thresholds": "",
            "title": "Used hugepages on the system",
            "transparent": true,
            "type": "singlestat",
            "valueFontSize": "80%",
            "valueMaps": [
              {
                "op": "=",
                "text": "N/A",
                "value": "null"
              }
            ],
            "valueName": "current"
          }
        ],
        "repeat": null,
        "repeatIteration": null,
        "repeatRowId": null,
        "showTitle": true,
        "title": "Bytes",
        "titleSize": "h6"
      }
    ],
    "schemaVersion": 14,
    "style": "dark",
    "tags": [
      "barometer"
    ],
    "templating": {
      "list": [
        {
          "current": {
            "text": "collectd",
            "value": "collectd"
          },
          "hide": 0,
          "label": null,
          "name": "datasource",
          "options": [],
          "query": "influxdb",
          "refresh": 1,
          "regex": "",
          "type": "datasource"
        },
        {
          "allValue": null,
          "current": {
            "tags": [],
            "text": "silpixa00390827.ir.intel.com",
            "value": "silpixa00390827.ir.intel.com"
          },
          "datasource": "collectd",
          "hide": 0,
          "includeAll": false,
          "label": null,
          "multi": false,
          "name": "Host",
          "options": [],
          "query": "SHOW TAG VALUES FROM hugepages_value WITH KEY=host",
          "refresh": 1,
          "regex": "",
          "sort": 0,
          "tagValuesQuery": "",
          "tags": [],
          "tagsQuery": "SHOW TAG VALUES FROM hugepages_value with key = instance WHERE (\"host\" =~ /^$host$/)",
          "type": "query",
          "useTags": true
        },
        {
          "allValue": null,
          "current": {
            "tags": [],
            "text": "mm-2048Kb",
            "value": "mm-2048Kb"
          },
          "datasource": "collectd",
          "hide": 0,
          "includeAll": false,
          "label": null,
          "multi": false,
          "name": "instance",
          "options": [],
          "query": "SHOW TAG VALUES FROM hugepages_value WITH KEY=instance",
          "refresh": 1,
          "regex": "",
          "sort": 0,
          "tagValuesQuery": "",
          "tags": [],
          "tagsQuery": "",
          "type": "query",
          "useTags": false
        }
      ]
    },
    "time": {
      "from": "now-15m",
      "to": "now"
    },
    "timepicker": {
      "refresh_intervals": [
        "5s",
        "10s",
        "30s",
        "1m",
        "5m",
        "15m",
        "30m",
        "1h",
        "2h",
        "1d"
      ],
      "time_options": [
        "5m",
        "15m",
        "1h",
        "6h",
        "12h",
        "24h",
        "2d",
        "7d",
        "30d"
      ]
    },
    "timezone": "",
    "title": "Hugepages",
    "version": 2
  },
  "overwrite": false
}