Giter Club home page Giter Club logo

integrationtemplate's Introduction

DEPRECATION NOTICE

This repository is no longer active. Creation of new Datadog integrations should follow the instructions laid out in the integration documentation.

Datadog Integration Tile Template

This repository is meant to help create tiles for Integrations which do not contain Python checks. Any Integrations which contain Python code - typically those that are run via the Agent - should use the standard tooling for generating tile templates.

Steps

  1. Download or fork the DataDog/IntegrationTemplate repository

  2. Copy the Integration directory to MyCheck

    cp -r Integration MyCheck
    
  3. Follow the Final Touches instructions for the following elements only:

  4. Edit MyCheck/README.md and provide the following sections:

    • ## Overview: Let others know what they can expect to do with your Integration
    • ## Setup: Information about how to install and configure your Integration
    • ## Metrics: List of the metrics (if any)
    • ## Events: List of events (if any)
    • ## Service Checks: List of service checks (if any)
  5. Commit your changes, push and submit a pull request

Need help?

Our friendly, knowledgeable solution engineers are here to help!

integrationtemplate's People

Contributors

2bethere avatar deterralba avatar irabinovitch avatar jeremy-lq avatar mikepultz avatar nmuesch avatar ofek avatar phrawzty avatar remh avatar truthbk avatar

Stargazers

 avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

integrationtemplate's Issues

Add metrics metadata

The template should include a CSV file that list the metrics, their type, their meaning with the following format:

metric_name,metric_type,interval,unit_name,per_unit_name,description,orientation,integration,short_name
postgresql.connections,gauge,,connection,,The number of active connections to this database.,0,postgres,pg conns
postgresql.commits,gauge,,transaction,second,The number of transactions that have been committed in this database.,0,postgres,pg commits
postgresql.rollbacks,gauge,,transaction,second,The number of transactions that have been rolled back in this database.,-1,postgres,pg rollbacks
postgresql.disk_read,gauge,,block,second,The number of disk blocks read in this database.,0,postgres,pg disk read
postgresql.buffer_hit,gauge,,hit,second,"The number of times disk blocks were found in the buffer cache, preventing the need to read from the database. ",1,postgres,pg buff hit
postgresql.rows_returned,gauge,,row,second,The number of rows returned by queries in this database,0,postgres,pg rows ret
postgresql.rows_fetched,gauge,,row,second,The number of rows fetched by queries in this database,0,postgres,pg rows fetch
postgresql.rows_inserted,gauge,,row,second,The number of rows inserted by queries in this database,0,postgres,pg rows insrt
postgresql.rows_updated,gauge,,row,second,The number of rows updated by queries in this database,0,postgres,pg rows updt
postgresql.rows_deleted,gauge,,row,second,The number of rows deleted by queries in this database,0,postgres,pg rows del
postgresql.database_size,gauge,,byte,,The disk space used by this database.,0,postgres,pg db size
postgresql.deadlocks,gauge,,,,The number of deadlocks detected in this database,-1,postgres,pg deadlocks
postgresql.temp_bytes,gauge,,byte,second,The amount of data written to temporary files by queries in this database.,0,postgres,pg temp bytes
postgresql.temp_files,gauge,,file,second,The number of temporary files created by queries in this database.,0,postgres,pg temp files
postgresql.bgwriter.checkpoints_timed,count,,,,The number of scheduled checkpoints that were performed.,0,postgres,pg bgw cp timed
postgresql.bgwriter.checkpoints_requested,count,,,,The number of requested checkpoints that were performed.,0,postgres,pg bgw cp req
postgresql.bgwriter.buffers_checkpoint,count,,,,The number of buffers written during checkpoints.,0,postgres,pg bgw buff cp
postgresql.bgwriter.buffers_clean,count,,,,The number of buffers written by the background writer.,0,postgres,pg bgw buff clean
postgresql.bgwriter.maxwritten_clean,count,,,,The number of times the background writer stopped a cleaning scan due to writing too many buffers.,0,postgres,pg bgw maxwr clean
postgresql.bgwriter.buffers_backend,count,,buffer,,The number of buffers written directly by a backend.,0,postgres,pg bgw buff bkend
postgresql.bgwriter.buffers_alloc,count,,,,The number of buffers allocated,0,postgres,pg bgw buff alloc
postgresql.bgwriter.buffers_backend_fsync,count,,,,The of times a backend had to execute its own fsync call instead of the background writer.,0,postgres,pg bgw buff bkend fsync
postgresql.bgwriter.write_time,count,,millisecond,,The total amount of checkpoint processing time spent writing files to disk.,0,postgres,pg bgw wrt time
postgresql.bgwriter.sync_time,count,,millisecond,,The total amount of checkpoint processing time spent synchronizing files to disk.,0,postgres,pg bgw sync time
postgresql.locks,gauge,,lock,,The number of locks active for this database.,0,postgres,pg locks
postgresql.seq_scans,gauge,,,,The number of sequential scans initiated on this table.,0,postgres,pg seq scans
postgresql.seq_rows_read,gauge,,row,second,The number of live rows fetched by sequential scans.,0,postgres,pg seq rows rd
postgresql.index_scans,gauge,,,,The number of index scans initiated on this table.,0,postgres,pg idx scans
postgresql.index_rows_fetched,gauge,,row,second,The number of live rows fetched by index scans.,0,postgres,pg idx rows fetch
postgresql.rows_hot_updated,gauge,,row,second,"The number of rows HOT updated, meaning no separate index update was needed.",0,postgres,pg rows hot updated
postgresql.live_rows,gauge,,row,,The estimated number of live rows.,0,postgres,pg live rows
postgresql.dead_rows,gauge,,row,,The estimated number of dead rows.,0,postgres,pg dead rows
postgresql.index_rows_read,gauge,,row,second,The number of index entries returned by scans on this index.,0,postgres,pg idx rows read
postgresql.table_size,gauge,,byte,,"The total disk space used by the specified table. Includes TOAST, free space map, and visibility map. Excludes indexes.",0,postgres,pg tbl size
postgresql.index_size,gauge,,byte,,The total disk space used by indexes attached to the specified table.,0,postgres,pg idx size
postgresql.total_size,gauge,,byte,,"The total disk space used by the table, including indexes and TOAST data.",0,postgres,pg tot size
postgresql.table.count,gauge,,table,,The number of user tables in this database.,0,postgres,pg tbl count
postgresql.max_connections,gauge,,connection,, The maximum number of client connections allowed to this database.,0,postgres,pg max conns
postgresql.percent_usage_connections,gauge,,fraction,,The number of connections to this database as a fraction of the maximum number of allowed connections.,0,postgres,pg pct usg conns
postgresql.heap_blocks_read,gauge,,block,second,The number of disk blocks read from this table.,0,postgres,pg heap blks read
postgresql.heap_blocks_hit,gauge,,hit,second,The number of buffer hits in this table.,0,postgres,pg heap blks hit
postgresql.index_blocks_read,gauge,,block,second,The number of disk blocks read from all indexes on this table.,0,postgres,pg idx blks read
postgresql.index_blocks_hit,gauge,,hit,second,The number of buffer hits in all indexes on this table.,0,postgres,pg idx blks hit
postgresql.toast_blocks_read,gauge,,block,second,The number of disk blocks read from this table's TOAST table.,0,postgres,pg toast blks read
postgresql.toast_blocks_hit,gauge,,hit,second,The number of buffer hits in this table's TOAST table.,0,postgres,pg toast blks hit
postgresql.toast_index_blocks_read,gauge,,block,second,The number of disk blocks read from this table's TOAST table index.,0,postgres,pg toast idx blks read
postgresql.toast_index_blocks_hit,gauge,,block,second,The number of buffer hits in this table's TOAST table index.,0,postgres,pg toast idx blks hit

We will use that in the web app to to provide more information about the metrics.

Datadog - Metric type Medadata on Metrics Summary

I have 2 metrics tracked with DogStatsD's increment function.
Both of them were setted as metric type "rate" on in-app (Metrics Summary).

On Dashboard 1), I'm showing a widget "Query Value"´s visualization: a = sum:mpcsgc.mpcsgc.hits{*}.as_count() and "take the average"

On Dashboard 2), I show 3 widgets:

  1. showing "a", the same as above
  2. showing a "Query Value"´s visualization: b = sum:mpcsgc.mpcsgc.total{*}.as_count() and "take the average"
  3. the arithmetic: a/b

And I got the values:
Dash 1: a=1.10
Dash 2: a=82518 b=81913 a/b=1.01

Now, I changed the metric a (mpcsgc.hits) as "count" on in-app (Metrics Summary), and refreshed my browser, but I got:
Dash 1: a=0.11
Dash 2: a=8266 b=81913 a/b=0.1

Why 4 values so different for metric "a" ?

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.