Git Product home page Git Product logo

documentation's Introduction

Documentation site for Datadog

Welcome to the Datadog documentation repository. The markdown stored in this repo is published to the Datadog documentation site using hugo, a static website generation tool.

Contribute to the docs

Contributions are encouraged! If you notice something on one of the pages that needs an edit, open a pull request in this repo for the documentation team to review

Most pages on the documentation site feature an Edit button that sends you to the source file in this repo. You can make an edit straight from the GitHub website!

The edit button on a docs page

For more information on contributing, see the contribution guidelines.

Working on Docs

Datadog Staff

  • Always branch off of master; never commit directly to master.
  • Name your branch <SLACK_HANDLE>/<FEATURE_NAME>.
  • Consult our contributing guidelines.
  • When you're ready to commit, create a new pull request to master from your branch.
  • Use GitHub's draft pull request feature and appropriate labels such as "Do Not Merge" or "Work in Progress" until your PR is ready to be merged and live on production.
  • If you've named your branch correctly, a GitHub bot posts a link to the docs preview website for your PR. After the preview build completes, you can use the link to preview your changes.
  • To run the build locally, see Docs Build. This is an optional step and requires setup.

Outside Contributors

  • Fork the master branch.
  • Consult our contributing guidelines.
  • When you're ready to finalize your changes, commit them and make a pull request back to DataDog/master.
  • A Datadog technical writer might change your PR title with a DOCS ticket number, such as "[DOCS-9000]," which means it has been added to the team's internal Jira queue to triage and review. No action is necessary from you if we change the title of your PR.

A note about markdown

This site uses Goldmark for markdown, which is compliant with CommonMark 0.29.

If you include ANY Markdown in a file, give it a .md extension.

Make sure all files are lowercase. Macs are case-insensitive when creating links to images and pages, but our build server is not, so tests may work locally, but the site will fail in production.

Releasing

Within 10 minutes of merging to master, it deploys automatically.

How to add a new integration

See the dedicated doc page.

documentation's People

Contributors

alai97 avatar andrewardito avatar api-clients-generation-pipeline[bot] avatar bgdeutsch avatar buraizu avatar clutchski avatar cswatt avatar davidejones avatar drichards-87 avatar dussault-antoine avatar estherk15 avatar guacbot avatar hestonhoffman avatar ijkaylin avatar jeremy-lq avatar jhotta avatar jtappa avatar kayayarai avatar l0k0ms avatar lucaspimentel avatar margotlepizzera avatar maycmlee avatar mstbbs avatar nbparis avatar pcarioufr avatar rtrieu avatar ruthnaebeck avatar sarina-dd avatar technovangelist avatar zbayoff avatar

Stargazers

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

Watchers

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

documentation's Issues

Where is datadog.conf located?

*nix: /etc/dd-agent/datadog.conf
osx (source install): ~/.datadog-agent/agent/datadog.conf
Windows 2008: C:\ProgramData\Datadog
Windows (other): C:\Documents and Settings\All Users\Application Data\Datadog\

Windows: interactively test the agent

Run the agent's shell by navigating to C:\Program Files (x86)\Datadog\Datadog Agent and running shell.exe. From here you can run parts of the agent.

To test IIS:

ipaddress = 'blah'
import wmi
w = wmi.WMI(ipaddress, user=None, password=None)
wmi_cls = w.Win32_PerfFormattedData_W3SVC_WebService(name="_Total")[0]
print wmi_cls.BytesSentPerSec

Document the metric query language and data model

For example, the differences between functions and aggregators:

Yes, min, max and avg aren't functions per se, they're aggregators. We haven't documented our model as well as we should, but we consider functions as transforms of a single metric series, whereas aggregators combine many metric series's across tags. For example, if we had a metric called foo with values:

host:a = 1,1,4,1,1
host:b = 2,2,0,2,2

Using the min aggregator like min:foo{*} would turn the two series into a single series:

1,1,0,1,1

If we added a min function like min(foo{host:a}), we would get just a single value of 1.

If we had min(foo{*}), we'd still need an aggregator, in this case avg is assumed, so that would be:

avg:foo{} = 1.5, 1.5, 2, 1.5, 1.5
min(avg:foo{
}) = 1.5

If we wanted the hosts in tact, we would say min(foo{*} by {host}), then we'd apply the function to each series:

min(host:a) = 1
min(host:b) = 0

What are valid metric names?

Metric names must start with a letter, and after that may contain ascii alphanumerics, underscore and periods. Other characters will get converted to underscores. There is no max length

How do I get the list of hosts and their IDs?

Other API endpoints require the host_id to be passed, yet there is no clear way to get these IDs without clicking around on the infrastructure overview.

This will drive API changes, but it's probably a good place to start.

How do I share graphs on other sites?

currently we allow the embedding of specific graphs on other sites
if you open the editor on the graph you want to share, and click on the Share tab
you can generate an html snippet you can put on other sites

What are valid tags?

Metric names must start with a letter, and after that may contain alphanumerics, underscores, minuses, colons, periods and slashes. Other characters will get converted to underscores. Tags can be up to 200 characters long and support unicode.

API navigation bar should always be visible

I like the way the sidebar stays visible for the guides. It would be great it the same was true of the API Reference bar so I could switch languages and jump around without scrolling back to the top.

The difference between graphite metric queries and datadog

In terms of metric naming, we differ a little with Graphite in that a metric query is defined by a metric name and a scope, where a scope is one or more tags. To translate:

<application>.requests.<HTTP Method>.<Handler Class>.<Handler Method>.mean_90

into Datadog, we'd probably say:

<application>.requests.mean_90{http_method:<HTTP Method>, handler_class:<Handler Class>, handler_method:<Handler Method>}

Where <application>.requests.mean_90 is the metric name, and http_method:, handler_class:, handler_method: are tags, so a concrete example might look like:

sync.requests.mean_90{http_method:GET, handler_class:ItemHandler, handler_method:list}

To do aggregation, we can specify an aggregator as part of the metric query:

avg:sync.requests.mean_90{http_method:GET, handler_class:ItemHandler, handler_method:list}

This will graph a single series that's the average of that metric across the intersection of those tags. We support avg, sum, min, max aggregators. If you wanted to see all the possible series for a given tag facet, you can say:

avg:sync.requests.mean_90{handler_class:ItemHandler, handler_method:list} by {http_method}

Which would graph stacked area series for each http_method value like GET, POST, etc.

How do I get the version of the agent?

On linux, < 3.4.0:

cd /usr/share/datadog/agent && python -c 'import config; print config.get_version()'

Linux, >= 3.4.0:

/etc/init.d/datadog-agent status

Windows: ...

Duplicate "happened"

In Counters:

Counters

Counters track how many times something _happened happened_, like the number of database requests or page views.

dog.increment('database.query.count')
dog.increment('page_view.count', 10)

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.