Russ Savage [Ngrok] | InfluxDB QuickStart | InfluxDays NA 2021

InﬂuxDB Quickstart
Everything you need to know to get
started building your application
Russ Savage - Product Manager
@ Ngrok

© 2021 InﬂuxData Inc. All Rights Reserved.
Our Mission
An application that is designed to present temperature
readings to our users as raw metrics, and also aggregated by
minute, hour and day.
Our
Application

Cheats Assumptions
● We are focusing on the backend code (not frontend UI)
● We assume Temperature sensors POST JSON messages
● We are ignoring service reliability concerns
● We are ignoring most security concerns
● We are using Python & Flask

Our Quickstart Application
Public
Read API
Frontend
Store and
Aggregate Data
(InfluxDB)
Public
Write API

Write API Requirements
● Single Endpoint for Sensors to POST JSON payloads
○ Transform and forward payload to InfluxDB
● Open Questions
○ What is the InfluxDB Data Model?
○ What format does InfluxDB accept?
○ How do I authenticate with InfluxDB?
○ What’s the easiest way to write data to InfluxDB in Python?

InﬂuxDB Quickstart Glossary
● Organization - A workspace for a group of users
● Bucket - Combines the concept of a database and a retention
period (the duration of time that each data point persists)
● Measurement - A name to a group of data at a high level
● Tag set - A set of key-value pairs to group data at a low level
(values are strings)
● Field set - A set of key-value pairs to represent data (values are
numerical & strings)
● Series - A unique combination of measurement + tags

Line Protocol
● All data must be converted into Line Protocol before being
sent to the InfluxDB write API.
● Line Protocol follows the following format:
https:/
/docs.influxdata.com/influxdb/cloud/reference/syntax/line-protocol/
Tag Set
hostname=server02, us_west=az
Measurement
cpu_load
Field Set
temp=24.5, volts=7
Timestamp
1234567890000000

● API Tokens are needed for any 3rd
party system to access InfluxDB
data or resources.
● API Tokens are owned by a user,
and can have read/write
permissions for each Bucket.
● Your first token MUST be created
through the web interface.
https:/
/docs.influxdata.com/influxdb/cloud/security/tokens
InfluxDB API Tokens

● InﬂuxDB provides client libraries for common languages to
incorporate into your code and use the API easily.
InﬂuxDB Client Libraries

● Use the Point object included in every Client Library to
convert your data to Line Protocol.
Mapping Data to Line Protocol

● Find all this information in the Client Library examples:
○ URL
○ Org
○ Token
○ Bucket
Get Your Connection Details from InﬂuxDB

Example Write API Code

Where are we?
Public
Read
API
Frontend
Store and
Aggregate Data
(InfluxDB)
Public
Write
API

Read API Requirements
● Single endpoint to GET temperature data
○ Query from InﬂuxDB and provide results as JSON
● Open questions
○ How do we get data out of InﬂuxDB?

● Flux queries are the way
to extract data from
InfluxDB.
● Quickstart Flux Functions
○ from
○ range
○ filter
○ aggregateWindow
https:/
/docs.influxdata.com/flux/v0.x/
Flux: Powerful Data Scripting Language

Example Read API Code

● Flux is all about functions, so just add one
● Poor performance since the calculation is run on every query
Wait, what about aggregations?

● Run Flux queries on a schedule, store results for faster
access.
● More Flux Functions:
○ map - change the columns of values of each row
○ to - write data back to InﬂuxDB
InﬂuxDB Tasks: Create and store custom metrics

InﬂuxDB Tasks: Create and store custom metrics

Updated Read API Code
• Aggregation done once
on the server instead of
for each API request

● If you use VSCode, load the Flux VSCode plugin
○ Easily test and debug Flux code in your IDE
● Influx CLI
○ Quickly manage and automate against the InfluxDB APIs
● InfluxDB Templates / Stacks
○ GitOps workflows built into the platform for CI/CD
● Advanced Flux
○ Transform as much as you can in Flux to keep your client code
simple
● InfluxDB API Invocable Scripts
○ Your Flux Script is now an API your code can call
What’s Next?

Thank you!
russ@ngrok.com
GitHub: russorat

Russ Savage [Ngrok] | InfluxDB QuickStart | InfluxDays NA 2021

Recommandé

Recommandé

Contenu connexe

Tendances

Tendances (20)

Similaire à Russ Savage [Ngrok] | InfluxDB QuickStart | InfluxDays NA 2021

Similaire à Russ Savage [Ngrok] | InfluxDB QuickStart | InfluxDays NA 2021 (20)

Plus de InfluxData

Plus de InfluxData (20)

Dernier

Dernier (20)

Russ Savage [Ngrok] | InfluxDB QuickStart | InfluxDays NA 2021