Prometheus: 규칙 서식 도구.

:+1: * :100:

네, 좋습니다. 주석을 보존하는 것은 가장 큰(그리고 기본적으로 유일한) 문제입니다. 표현을 여러 줄로 나누는 방법에 대한 동의.

우리는 이것을 promtool에 추가하는 중에 있지 않습니까?

관련: https://github.com/prometheus/prometheus/pull/1779

몇 가지 관찰:

• 2.x 규칙 형식(PromQL을 포함하는 YAML)을 사용하면 이것이 YAML 파일에서도 작동하기를 원합니다.
• YAML과 PromQL에서 두 주석을 모두 보존해야 합니다.
• 들여쓰기는 중요합니다(단순한 줄 바꿈이 아님).
• 입력의 특정 줄 바꿈이 출력에서 ​​유지되어야 하는지 확인해야 합니다( gofmt 가 이를 수행하는 방법 참조).
• 규칙이 렌더링될 때마다 특히 Prometheus 웹 UI의 _Alerts_ 및 _Rules_ 탭에서 동일한 형식이 적용되어야 합니다. 이것은 AST가 주석을 유지해야 함을 의미합니다(및 특정 줄 바꿈, 이전 항목 참조).

YAML에서 두 주석을 모두 보존해야 합니다.

우리의 현재 YAML 라이브러리는 이것을 하지 않지만 "곧" 되기를 바라고 있습니다.

내 gsoc 제안서에 이것을 포함하고 싶습니다. @brian-brazil, 언급하는 YAML 라이브러리에 연결할 수 있습니까?

https://github.com/go-yaml/yaml 하지만 이 범위를 PromQL로만 지정하겠습니다.

@brian-brazil 하지만 규칙의 PromQL은 항상 YAML 파일에 포함되기 때문에 최소한 YAML 주석은 보존해야 합니다. 맞죠? 그렇지 않으면 아무도 서식 지정의 이점을 자신의 의견을 잃고 싶어하지 않기 때문에 도구가별로 유용하지 않을 것입니다.

좋겠지만 그것 없이도 혜택을 받을 수 있습니다. 나는 또한 gsoc 프로젝트에 대한 일정이 불분명한 것에 의존하지 않고 싶습니다.

PromQL 부분부터 시작하겠습니다. 라이브러리가 주석 및 여러 줄 문자열에 대한 |2 들여쓰기 힌트를 보존하면 YAML 부분은 거의 간단해야 합니다.

확인!

이 모든 것을 허용해야 하는 YAML 라이브러리의 v3이 종료되었습니다.

참고로 구성에서 완벽하게 읽을 수 있는 규칙

(
    kube_job_status_failed > 0
    UNLESS kube_job_status_succeeded > 0
)
* on (namespace, job_name) group_left(maintainer) label_replace(kube_job_labels, "maintainer", "$1", "label_maintainer", "(.*)")
* on (namespace, job_name) group_left(pager) label_replace(kube_job_labels, "pager", "$1", "label_pager", "(.*)")
* on (namespace, job_name) group_left(paging) label_replace(kube_job_labels, "paging", "$1", "label_paging", "(.*)")

VS 웹 UI의 가비지 표현

(kube_deployment_status_replicas_available
  / kube_deployment_spec_replicas * 100) * on(namespace, deployment) group_left(maintainer)
  label_replace(kube_deployment_labels, "maintainer", "$1", "label_maintainer",
  "(.*)") * on(namespace, deployment) group_left(pager) label_replace(kube_deployment_labels,
  "pager", "$1", "label_pager", "(.*)") * on(namespace,
  deployment) group_left(paging) label_replace(kube_deployment_labels, "paging",
  "$1", "label_paging", "(.*)") < 100

@sylr 웹 UI에서 다른 규칙을 게시한 것 @beorn7 이 문제에 대한 작업을 시작했습니다.

귀하의 규칙에 대해 다음과 같이 표시됩니다.

(kube_job_status_failed
  > 0 unless kube_job_status_succeeded > 0) * on(namespace, job_name) group_left(maintainer)
  label_replace(kube_job_labels, "maintainer", "$1", "label_maintainer",
  "(.*)") * on(namespace, job_name) group_left(pager) label_replace(kube_job_labels,
  "pager", "$1", "label_pager", "(.*)") * on(namespace,
  job_name) group_left(paging) label_replace(kube_job_labels, "paging", "$1",
  "label_paging", "(.*)")

@geekodour 예, 두 가지 규칙을 혼동했습니다.

이것은 아직 열려 있고 향후 GSOC(https://github.com/cncf/soc#rule-formatting-tool)에 대한 프로젝트 아이디어에 추가되기 때문에 GSOC 동안 이 작업을 완료하고 싶습니다. 이에 관한 최신 업데이트 및 추가 정보는 @codesome @brian-brazil @juliusv @geekodour @simonpasquier @sylr에 감사드립니다.
주석 및 기타 참조 링크를 읽은 후 다음 작업 포인트는 promQL AST를 사용하여 promQL 표현식을 위한 포맷터를 구축하는 것 같습니다.

@haibeey 이미 그 방향으로 약간의 진전이 있었습니다.

이러한 포맷터를 구축할 때 이미 여기에 구현된 것으로 시작하고 적절한 공백과 주석 처리를 추가하는 것이 가장 좋습니다.

이러한 기능이 곧 출시될 PromQL 언어 서버 와 통합될 수 있다면 좋을 것입니다. 언어 서버 코드 내부에는 YAML 파일의 형식을 지정하는 데 필요한 많은 항목이 이미 구현되어 있으며 일부를 재사용하는 것이 합리적일 수 있습니다.

괜찮은! @slrtbtfs 감사

이 문제를 해결할 수 있습니까? 이것을 구현하고 싶습니다.

@haibeey 는 이미 어떻게든 이 작업을 계획하고 있는 것 같습니다.

@roidelaluie 나는 이미 그 일부를 이전에 구현했습니다. 여기서 언급하지 않았을 뿐입니다.

참고로 구성에서 완벽하게 읽을 수 있는 규칙

(
    kube_job_status_failed > 0
    UNLESS kube_job_status_succeeded > 0
)
* on (namespace, job_name) group_left(maintainer) label_replace(kube_job_labels, "maintainer", "$1", "label_maintainer", "(.*)")
* on (namespace, job_name) group_left(pager) label_replace(kube_job_labels, "pager", "$1", "label_pager", "(.*)")
* on (namespace, job_name) group_left(paging) label_replace(kube_job_labels, "paging", "$1", "label_paging", "(.*)")

VS 웹 UI의 가비지 표현

(kube_deployment_status_replicas_available
  / kube_deployment_spec_replicas * 100) * on(namespace, deployment) group_left(maintainer)
  label_replace(kube_deployment_labels, "maintainer", "$1", "label_maintainer",
  "(.*)") * on(namespace, deployment) group_left(pager) label_replace(kube_deployment_labels,
  "pager", "$1", "label_pager", "(.*)") * on(namespace,
  deployment) group_left(paging) label_replace(kube_deployment_labels, "paging",
  "$1", "label_paging", "(.*)") < 100

이 서식 스타일이 허용됩니까? @codesome @juliusv @brian-brazil @beorn7
이 스타일을 기반으로 제안서를 작성하고 있습니다.

포맷 후 최종 표현은 GSoC 기간 동안 논의되고 결정될 수 있습니다. 나는 (모든 GSoC 지망자들에게) 이것을 _어떻게_ 달성할 것인가에 초점을 맞출 것을 제안합니다.

https://prometheus.io/docs/practices/rules/ 는 모범 사례를 사용합니다.

goyacc 문법 규칙을 약간 보강하여 주석을 보존하기 위해 대략적인 프로토타입을 작성했습니다. 여기에서 커밋하십시오. https://github.com/haibeey/prometheus/commit/885566786ac20bfd400b2e7db470c92545919690

규칙 파일
웹 UI의 녹음 규칙

그것은 옳지 않아 보입니다. 운영자는 자신의 라인에 있지 않습니다.

어 그래. 그 커밋은 포맷을 하지 않습니다. 인쇄를 위해 평가한 후 promql expr의 주석을 보존하기 위한 것입니다.
이전 버전은 평가 후 모든 주석을 무시합니다.

goyacc 문법 규칙을 약간 보강하여 주석을 보존하기 위해 대략적인 프로토타입을 작성했습니다. 여기서 커밋 [haibeey@8855667]

AST에 주석을 넣는 것은 합리적인 생각처럼 보입니다.

거기에 구현에 대한 몇 가지 의견을 남겼습니다.

https://prometheus.io/docs/practices/rules/ 는 모범 사례를 사용합니다.

다음을 시행하지 마십시오.

sum without (instance)(instance_path:requests:rate5m{job="myjob"})

~ 위에

sum(instance_path:requests:rate5m{job="myjob"}) without (instance)

그룹화 수정자를 먼저 사용하는 것이 가장 좋은 방법이며 이미 인쇄 방식입니다. 그렇지 않으면 중요하지 않은 표현식을 읽기가 매우 어렵습니다.

네, 저는 처음에 이것에 대해 강한 의견을 가지고 있었습니다. 처음에 Prometheus는 sum(x) by(y) 만 지원했는데, 그 이유는 저에게 더 영어처럼 읽혀서 저는 훨씬 더 선호했지만, 사소한 x 경우 어떤 차원을 집계하고 있는지 보기가 정말 어려워집니다. / 유지. 처음부터 sum by(y) (x) 로 만들고 유일한 법적 변형으로 만들었으면 합니다.

나는 아직도 전혀 좋아하지 않아 정확한 서식 sum by (y)(x) 선호 정도와 sum by(y) (x) (나에게 많은 의미가 있습니다), 우리는 문서에서 후자에 갈 것을 선택하지 않도록 이유.

나는 모든 사람이 이것에 대해 자신의 의견을 가질 자격이 있다고 생각합니다. 저는 개인적으로 "모범 사례"가 끔찍하다고 생각하지만 모든 구문이 합법이므로 하나를 다른 구문 위에 적용하지 마십시오.

promfmt 도구의 요점은 시행하지 않더라도 gofmt 와 매우 유사한 특정 "정식" 형식을 뒤에 전체 인수 문자열과 함께 "보증"하는 것입니다.

예, gofmt 의 형식은 아무도 좋아하지 않지만 최소한 그 자체로 가치가 있는 많은 다른 스타일보다는 하나의 일관된 스타일을 만듭니다.

참고로 이것은 GSoC에서 적극적으로 추구되고 있습니다. @haibeey GSoC 에도 관심이 있으신가 봅니다. 지금 해주신 선행 작업에 감사드리며 GSoC에서 프로젝트를 보다 쉽게 ​​조정할 수 있도록 GSoC 제안 또는 기타에서 공개 토론과 디자인 공유에 감사드립니다. :)

새로운 go-yamlv3 라이브러리에서 주석 보존 기능이 이미 잘 지원됩니다. 구현이 너무 완벽하여 주석의 손실이 없습니다. 따라서 우리는 걱정 없이 Prometheus 코드와 독립적으로 메커니즘을 유지할 수 있습니다.

괜찮은. 내 제안 초안 GSoC 제안을 공유할 시간입니다.

최종 초안이 작성되기 전에 검토해 주시면 감사하겠습니다. 감사 해요

@Harkishen-Singh 두 가지 수준의 주석이 있습니다. YAML 주석과 PromQL 표현식 내의 주석입니다. https://github.com/prometheus/prometheus/issues/21#issuecomment -604213849는 PromQL에 대해 이야기하고 있었습니다(그러나 YAML도 보존하는 것이 좋습니다).

새로운 go-yamlv3 라이브러리에서 주석 보존 기능이 이미 잘 지원됩니다. 구현이 너무 완벽하여 주석의 손실이 없습니다. 따라서 우리는 걱정 없이 Prometheus 코드와 독립적으로 메커니즘을 유지할 수 있습니다.

PromQL 표현식을 평가하는 동안 주석이 제거됩니다.
즉, 형식 지정은 규칙 파일뿐만 아니라 웹 UI와 같은 일부 위치에서도 수행되어야 한다고 생각합니다. @juliusv 이게 사실
따라서 @slrtbtfs가 지적한

YAML 주석과 관련하여 Cortex에 문제를 일으키는 v3 문제가 있으므로 이 문제가 모두 해결될 때까지 추가 롤아웃을 피해야 합니다.

즉, 형식 지정은 규칙 파일뿐만 아니라 웹 UI와 같은 일부 위치에서도 수행되어야 한다고 생각합니다. 이게 사실이야?

웹 UI는 완료되는 유일한 장소입니다.