ntopng Logo
5.7

User's Guide

  • What is ntopng
  • Use Cases
  • Basic Concepts
  • How to Start ntopng
  • Adding a License
  • Command Line Options
  • The ntopng Web GUI
  • Interfaces
  • Alerts
  • Using ntopng with ntop Tools
  • Historical Flow Report
  • Docker/Kubernetes
  • ClickHouse
  • Kafka
  • Advanced Features
  • Operating ntopng on large networks
  • Third-Party Integrations
  • FAQ
  • Performance and Hardware Sizing

Developer's Guide

  • Developing Plugins
  • API Documentation
    • RESTful API
    • Lua API
    • Python API
    • Timeseries API
      • Basic Concepts
      • Exporting Data
      • Modify an existing Schema
      • Adding New Metrics
      • Accessing Metrics
      • Metrics
      • Querying Data
      • ts_utils API
      • Driver Implementation
    • Alerts API
    • Recording API

Other Products

  • nProbe
  • nProbe Cento
  • n2disk
  • nDPI
  • PF_RING
  • nEdge
  • nScrub
  • nBox
  • nTap
ntopng
  • Docs »
  • API Documentation »
  • Timeseries API
  • View page source

Timeseries API¶

The ntopng timeseries framework provides an abstraction over the timeseries databases to handle writes and queries in a way that’s independent of the specific implementation.

  • Basic Concepts
    • Schema
    • Schema Name
    • Metric Types
    • Driver
  • Exporting Data
  • Modify an existing Schema
  • Adding New Metrics
    • General Overview
      • Case 1: Adding metrics via the ::lua method
      • Case 2: Adding metrics inside a TimeseriesPoint
      • Case 3: Adding metrics for Lua only objects
    • Custom Timeseries Scripts
      • Structure of Custom Timeseries Scripts
      • Example
    • Charting New Metrics
  • Accessing Metrics
    • Interface Metrics
    • Host Metrics
  • Metrics
    • Interface Metrics
    • Device Metrics
    • Host Metrics
    • Subnet Metrics
    • VLAN Metrics
    • SNMP Interface Metrics
    • Traffic Profile Metrics
    • Host Pool Metrics
    • ASN Metrics
    • Country Metrics
    • sFlow Device Metrics
    • Flow Device Metrics
    • Event Exporter Metrics
    • Container Metrics
    • POD Metrics
    • Process Metrics
    • System Metrics
  • Querying Data
    • Number Of Hosts In The Last Minute
    • Traffic On An Interface In The Last Minute
    • Traffic On An Interface In The Last Hour, Per Minute
    • Traffic On An Interface In The Last Hour
  • ts_utils API
  • Driver Implementation
Next Previous

© Copyright 2023, ntop

Built with Sphinx using a theme provided by Read the Docs.