ddpaw

Name	ddpaw JSON
Version	0.1.0 JSON
	download
home_page	None
Summary	Extract APM metrics from DataDog
upload_time	2024-05-16 07:30:17
maintainer	None
docs_url	None
author	benbenbang
requires_python	<4.0,>=3.10
license	None
keywords
VCS
bugtrack_url
requirements	No requirements were recorded.
Travis-CI	No Travis.
coveralls test coverage	No coveralls.

            # DDPaw CLI Tool

## Description

`ddpaw` is a command-line tool for extracting, visualizing, and analyzing metrics from Datadog's Application Performance Monitoring (APM) service based on a query. It provides a set of commands to help you manage and interact with metrics data.



## Table of Contents

[TOC]

## Installation

```bash
pip install --no-cache-dir ddpaw
```



## Usage

`ddpaw` provides several commands to interact with Datadog metrics

```bash
ddpaw <command> [options]
```

Set up your DataDog API credentials by creating a `.env` file in the project root directory:

```bash
API_KEY=your-api-key
APP_KEY=your-app-key
```



### Commands

#### export

> Export metrics data based on the given query and time range.

##### Options

- `-s`, `--start_at`: The start time of the time range (required).
- `-e`, `--end_at`: The end time of the time range (required).
- `-q`, `--query`: The query to retrieve metrics data (required).
- `--format`: The format of the data (choices: `csv`, `json`).
- `--all-response`: Flag indicating whether to include all response data.
- `-v`, `--verbose`: Flag indicating whether to display verbose output.

##### Example

```bash
ddpaw export -s 2024-04-05T12:00:00 -e 2024-04-05T17:30:00 \
						 -q "sum:trace.fastapi.request.hits{env:prod,service:d2api-api} by {version}.as_rate()" \
						 --format=csv
```



#### visualize

Visualize metrics data based on the given query and time range.

##### Options

- `-s`, `--start_at`: The start time of the time range (required).
- `-e`, `--end_at`: The end time of the time range (required).
- `-q`, `--query`: The query to retrieve metrics data (required).
- `-v`, `--verbose`: Flag indicating whether to display verbose output.

##### Example

```bash
ddpaw visualize -s 2024-04-05T12:00:00 -e 2024-04-05T17:30:00 \
							  -q "sum:trace.fastapi.request.hits{env:prod,service:d2api-api} by {version}.as_rate()"
```



### analyze

Analyze metrics data based on the given query and time range.

##### Options

- `-s`, `--start_at`: The start time of the time range (required).
- `-e`, `--end_at`: The end time of the time range (required).
- `-q`, `--query`: The query to retrieve metrics data (required).
- `-v`, `--verbose`: Flag indicating whether to display verbose output.

##### Example

```bash
ddpaw analyze -s 2024-04-05T12:00:00 -e 2024-04-05T17:30:00 \
							-q "sum:trace.fastapi.request.hits{env:prod,service:d2api-api} by {version}.as_rate()"
```



### Completions

Generate shell completions for `ddpaw`.

#### Arguments

- `shell`: The shell type (choices: `bash`, `zsh`, `fish`).

For example:

```bash
ddpaw completions bash
```



## Contributing

Contributions are welcome! Please follow the guidelines in [CONTRIBUTING.md](CONTRIBUTING.md).



## License

This project is licensed under the [MIT License](LICENSE).

            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "ddpaw",
    "maintainer": null,
    "docs_url": null,
    "requires_python": "<4.0,>=3.10",
    "maintainer_email": null,
    "keywords": null,
    "author": "benbenbang",
    "author_email": "ben.chen@vestiairecollective.com",
    "download_url": "https://files.pythonhosted.org/packages/46/cc/ad41839f0b6500502a335d29a34852156f76d4250733300d0401fca76162/ddpaw-0.1.0.tar.gz",
    "platform": null,
    "description": "# DDPaw CLI Tool\n\n## Description\n\n`ddpaw` is a command-line tool for extracting, visualizing, and analyzing metrics from Datadog's Application Performance Monitoring (APM) service based on a query. It provides a set of commands to help you manage and interact with metrics data.\n\n\n\n## Table of Contents\n\n[TOC]\n\n## Installation\n\n```bash\npip install --no-cache-dir ddpaw\n```\n\n\n\n## Usage\n\n`ddpaw` provides several commands to interact with Datadog metrics\n\n```bash\nddpaw <command> [options]\n```\n\nSet up your DataDog API credentials by creating a `.env` file in the project root directory:\n\n```bash\nAPI_KEY=your-api-key\nAPP_KEY=your-app-key\n```\n\n\n\n### Commands\n\n#### export\n\n> Export metrics data based on the given query and time range.\n\n##### Options\n\n- `-s`, `--start_at`: The start time of the time range (required).\n- `-e`, `--end_at`: The end time of the time range (required).\n- `-q`, `--query`: The query to retrieve metrics data (required).\n- `--format`: The format of the data (choices: `csv`, `json`).\n- `--all-response`: Flag indicating whether to include all response data.\n- `-v`, `--verbose`: Flag indicating whether to display verbose output.\n\n##### Example\n\n```bash\nddpaw export -s 2024-04-05T12:00:00 -e 2024-04-05T17:30:00 \\\n\t\t\t\t\t\t -q \"sum:trace.fastapi.request.hits{env:prod,service:d2api-api} by {version}.as_rate()\" \\\n\t\t\t\t\t\t --format=csv\n```\n\n\n\n#### visualize\n\nVisualize metrics data based on the given query and time range.\n\n##### Options\n\n- `-s`, `--start_at`: The start time of the time range (required).\n- `-e`, `--end_at`: The end time of the time range (required).\n- `-q`, `--query`: The query to retrieve metrics data (required).\n- `-v`, `--verbose`: Flag indicating whether to display verbose output.\n\n##### Example\n\n```bash\nddpaw visualize -s 2024-04-05T12:00:00 -e 2024-04-05T17:30:00 \\\n\t\t\t\t\t\t\t  -q \"sum:trace.fastapi.request.hits{env:prod,service:d2api-api} by {version}.as_rate()\"\n```\n\n\n\n### analyze\n\nAnalyze metrics data based on the given query and time range.\n\n##### Options\n\n- `-s`, `--start_at`: The start time of the time range (required).\n- `-e`, `--end_at`: The end time of the time range (required).\n- `-q`, `--query`: The query to retrieve metrics data (required).\n- `-v`, `--verbose`: Flag indicating whether to display verbose output.\n\n##### Example\n\n```bash\nddpaw analyze -s 2024-04-05T12:00:00 -e 2024-04-05T17:30:00 \\\n\t\t\t\t\t\t\t-q \"sum:trace.fastapi.request.hits{env:prod,service:d2api-api} by {version}.as_rate()\"\n```\n\n\n\n### Completions\n\nGenerate shell completions for `ddpaw`.\n\n#### Arguments\n\n- `shell`: The shell type (choices: `bash`, `zsh`, `fish`).\n\nFor example:\n\n```bash\nddpaw completions bash\n```\n\n\n\n## Contributing\n\nContributions are welcome! Please follow the guidelines in [CONTRIBUTING.md](CONTRIBUTING.md).\n\n\n\n## License\n\nThis project is licensed under the [MIT License](LICENSE).\n",
    "bugtrack_url": null,
    "license": null,
    "summary": "Extract APM metrics from DataDog",
    "version": "0.1.0",
    "project_urls": null,
    "split_keywords": [],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "8c5321aabf9abbe9f0cbc2f4aaae7c40486dc5533d7adc8e7986b9566b954761",
                "md5": "d344690cac71da0cfe587f9785cddce1",
                "sha256": "537d785b3e489b60d6a05fa505b7e7ae4cf04e13815974770862f8e443312979"
            },
            "downloads": -1,
            "filename": "ddpaw-0.1.0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "d344690cac71da0cfe587f9785cddce1",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": "<4.0,>=3.10",
            "size": 8903,
            "upload_time": "2024-05-16T07:30:15",
            "upload_time_iso_8601": "2024-05-16T07:30:15.605718Z",
            "url": "https://files.pythonhosted.org/packages/8c/53/21aabf9abbe9f0cbc2f4aaae7c40486dc5533d7adc8e7986b9566b954761/ddpaw-0.1.0-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "46ccad41839f0b6500502a335d29a34852156f76d4250733300d0401fca76162",
                "md5": "49f6002fb524ffdcf6b413c494b8154e",
                "sha256": "3e45b87d37a117124aae67e4bb2a3326e2932da7cd6bf1aedf5dd92a7952b7da"
            },
            "downloads": -1,
            "filename": "ddpaw-0.1.0.tar.gz",
            "has_sig": false,
            "md5_digest": "49f6002fb524ffdcf6b413c494b8154e",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": "<4.0,>=3.10",
            "size": 8130,
            "upload_time": "2024-05-16T07:30:17",
            "upload_time_iso_8601": "2024-05-16T07:30:17.779460Z",
            "url": "https://files.pythonhosted.org/packages/46/cc/ad41839f0b6500502a335d29a34852156f76d4250733300d0401fca76162/ddpaw-0.1.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-05-16 07:30:17",
    "github": false,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "lcname": "ddpaw"
}