Atlas 경고 설정 만들기

이 페이지의 내용

구문

옵션
상속된 옵션
출력
예시

프로젝트에 대한 경고 구성을 만듭니다.

이 명령을 사용하려면 프로젝트 소유자 역할이 있는 사용자 계정 또는 API 키로 인증해야 합니다.

구문

명령 구문

atlas alerts settings create [options]

옵션

이름	유형	필수 사항	설명
--apiKey	문자열	거짓	Datadog API 키, Opsgenie API 키 또는 VictorOps API 키입니다. 알림 유형이 각각 DATADOG, OPS_GENIE 또는 VICTOR_OPS인 경우 필수입니다.
--Enabled		거짓	경고 구성을 활성화할지 여부를 나타내는 플래그입니다.
--event	문자열	거짓	경고를 트리거한 이벤트 유형입니다. CLI에서 허용하는 값을 알아보려면 Atlas 관리자 API 사양의 eventTypeName에 대한 열거형을 참조하세요: https://dochub.mongodb.org/core/atlas-event-names.
-f, --file	문자열	거짓	경고 구성 설정을 정의하는 JSON 구성 파일 의 경로입니다. Atlas CLI 의 경고 구성 파일에 학습 보려면 https://dochub.mongodb.org/core/alert-config-atlas-cli를 참조하세요.
-h, --help		거짓	만들기 도움말
--matcherFieldName	문자열	거짓	일치시킬 대상 객체의 필드 이름입니다. 유효한 값을 알아보려면 atlas 경고 설정 필드 유형을 실행합니다.
--matcherOperator	문자열	거짓	matcherValue와 비교하여 현재 지표를 확인할 때 적용할 비교 연산자입니다. 유효한 값은 CONTAINS, ENDS_WiTH, EUALS, NOT_CONTAINS, NOT_EUALS, REGEX, STARTS_WiTH입니다.
--matcherValue	문자열	거짓	지정된 연산자로 테스트할 값입니다. matcherFieldName이(가) TYPE_NAME으로 설정된 경우 CONFIG, Mongo, PRIMARY, SECONDARY, 독립형 값을 일치시킬 수 있습니다.
--metricMode	문자열	거짓	Atlas가 현재 지표 값을 평균으로 계산할지 여부를 나타내는 옵션입니다. 유효한 값은 AVERAGE입니다.
--metricName	문자열	거짓	이 명령이 구성된 경고를 확인하는 지표의 이름입니다. 유효한 값을 알아보려면 https://dochub.mongodb.org/core/alert-host-metrics-atlas 를 참조하세요. . 이 옵션은 이벤트가 OUTSIDE_METRIC_THRESHOLD로 설정된 경우에만 적용됩니다.
--metricOperator	문자열	거짓	현재 지표 값을 확인할 때 적용할 비교 연산자입니다. 유효한 값은 LESS_TEAN 및 GREATER_TEAN입니다.
--metricThreshold	float	거짓	이 값을 벗어나면 경고가 트리거되는 임계값입니다.
--metricUnits	문자열	거짓	임계값의 단위입니다. 유효한 값은 BITS, BYTES, DAYS, GIGABITS, GIGABYTES, HOURS, KILOBITS, KILOBYTES, MEGABITS, MEGABYTES, MILLIZECONDS, MINITES, Petabytes, RAW, SECONDS, TERABYTES입니다.
--notificationChannelName	문자열	거짓	Slack 채널 이름입니다. SLACK 알림 유형에 필요합니다.
--notificationDelayMin	int	거짓	경고 조건이 감지된 후 첫 번째 알림을 보내기 전에 대기할 시간(분)입니다.
--notificationEmailAddress	문자열	거짓	경고 알림이 전송되는 이메일 주소입니다.
--notificationEmailEnabled		거짓	이메일 알림을 활성화하는 플래그입니다. GROUP 및 USER 알림 유형에 맞게 구성할 수 있습니다.
--notificationIntervalMin	int	거짓	해결되지 않은 승인되지 않은 경고에 대한 연속 알림 사이에 대기할 시간(분)입니다.
--notificationMobileNumber	문자열	거짓	경고 알림이 전송될 휴대폰 번호입니다.
--notificationRegion	문자열	거짓	사용할 API URL을 나타내는 리전입니다.
--notificationRole	strings	거짓	구성된 경고를 수신하는 하나 이상의 조직 또는 프로젝트 역할이 포함된 목록입니다.
--notificationServiceKey	문자열	거짓	PagerDuty 서비스 키입니다.
--notificationSmsEnabled		거짓	문자 메시지 알림을 활성화하는 플래그입니다.
--notificationTeamId	문자열	거짓	팀의 고유 식별자입니다.
--notificationToken	문자열	거짓	Slack API 토큰 또는 Bot 토큰입니다.
--notificationType	문자열	거짓	경고 알림의 유형입니다. 유효한 값은 DATADOG, EMAIL, GROUP(프로젝트), Microsoft, ORG, OPS_GENIE, PAGER_DUTY, Slack, SMS, 팀, USER, VICTOR_OPS 또는 WEBHOOK입니다.
--notificationUsername	문자열	거짓	알림을 보낼 Atlas user의 이름입니다.
--notificationVictorOpsRoutingKey	문자열	거짓	Splunk 온콜 계정과 연결된 라우팅 키입니다.
--notificationWebhookSecret	문자열	거짓	웹훅 기반 경고에 대한 인증 비밀입니다.
--notificationWebhookUrl	문자열	거짓	웹훅 기반 경고 또는 Microsoft Teams 경고의 대상 URL입니다.
-o, --output	문자열	거짓	출력 형식입니다. 유효한 값은 json, json-path, go-템플릿 또는 go-템플릿 파일입니다. 전체 출력을 보려면 -o json 옵션을 사용합니다.
--projectId	문자열	거짓	사용할 프로젝트를 식별하는 16진수 문자열입니다. 이 옵션은 구성 파일 또는 환경 변수의 설정을 재정의합니다.

상속된 옵션

이름	유형	필수 사항	설명
-P, --profile	문자열	거짓	구성 파일에서 사용할 프로필의 이름입니다. Atlas CLI의 프로필에 대해 자세히 알아보려면 https://dochub.mongodb.org/core/atlas-cli-save-connection-settings를 참조하세요.

출력

명령이 성공하면 Atlas CLI는 다음 샘플과 유사한 출력을 반환합니다. 괄호 안의 값은 사용자의 값을 나타냅니다.

Alert configuration <Id> created.

예시

# Create an alert configuration that notifies a user when they join a group for the project with the ID 5df90590f10fab5e33de2305:
atlas alerts settings create --event JOINED_GROUP --enabled \
--notificationType USER --notificationEmailEnabled \
--notificationIntervalMin 60 --notificationUsername john@example.com \
--output json --projectId 5df90590f10fab5e33de2305

# Create alert using json file containing alert configuration
atlas alerts settings create 5d1113b25a115342acc2d1aa --file alerts.json

# Create an alert that shows possible connection storms based on the number of connections
atlas alerts settings create --event OUTSIDE_METRIC_THRESHOLD --metricName CONNECTIONS --metricOperator LESS_THAN --metricThreshold 1 --metricUnits RAW --projectId 5df90590f10fab5e33de2305 --notificationType GROUP --notificationEmailEnabled --notificationIntervalMin 5 --enabled

돌아가기

설정

삭제