@ datadog/ action- catalog

类型脚本客户端库 数据犬动作目录。为50+集成(包括AWS、Azure、GCP、GitHub、Slack、Jira、PagerDuty、Datadog API等)的执行行动提供完全的打入功能.

安装

npm install @datadog/action-catalog
# or
yarn add @datadog/action-catalog

设置

在调用任何动作功能之前, 您必须注册执行程序 。 这使得图书馆可以在任何运行时间环境中工作.

import { setExecuteActionImplementation } from '@datadog/action-catalog/action-execution';

setExecuteActionImplementation(async (actionId, request) => {
    // Your implementation for executing actions against the Datadog API
    const response = await fetch(
        `https://api.datadoghq.com/api/v2/actions/${actionId}/execute`,
        {
            method: 'POST',
            headers: {
                'Content-Type': 'application/json',
                'DD-API-KEY': process.env.DD_API_KEY,
                'DD-APPLICATION-KEY': process.env.DD_APP_KEY,
            },
            body: JSON.stringify(request),
        },
    );
    return response.json();
});

使用量

从集成特定切入点导入动作功能. 每项职能都用请求投入和响应产出来打字.

import { listObjects } from '@datadog/action-catalog/aws/s3';
import { createMonitor } from '@datadog/action-catalog/dd/monitor';
import { deleteChat } from '@datadog/action-catalog/slack/chat';

// List S3 objects
const objects = await listObjects({
    inputs: {
        bucket: 'my-bucket',
        region: 'us-east-1',
    },
});

// Create a Datadog monitor
const monitor = await createMonitor({
    inputs: {
        name: 'High CPU Alert',
        monitorType: 'metric alert',
        message: 'CPU usage is above 90%',
    },
});

// Delete a Slack message
await deleteChat({
    inputs: {
        channel: 'C1234567890',
        ts: '1234567890.123456',
        teamId: 'T1234567890',
    },
});

支持的整合

每种集成方式作为单独的导入路径,在 @datadog/action-catalog/<integration>/<module>数字 :

参见《公约》现有整合的完整清单 数据犬动作目录文档。 。 。 .

API 模式

每个动作功能都遵循相同的模式:

function actionName(request: { inputs: ActionInputs }): Promise<ActionOutputs>;

• inputs ——动作参数,每个动作全部打入.
• 回返 ——承诺解决打入式行动响应.

许可证

麻省理工学院