Skip to content

Commit e131e56

Browse files
docs(locadex): add translations
1 parent f069afb commit e131e56

9 files changed

Lines changed: 9000 additions & 8425 deletions

File tree

gt-lock.json

Lines changed: 8411 additions & 8411 deletions
Large diffs are not rendered by default.

i18n/jp/docusaurus-plugin-content-docs/current/cloud/managed-postgres/monitoring/query-insights.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -168,6 +168,18 @@ patterns または recent queries テーブル内の任意の行をクリック
168168
遅いパターンの診断に必要な情報はすべて、1 つの
169169
画面にまとまっています。
170170

171+
## クエリインサイト API \{#api\}
172+
173+
同じテレメトリーは、
174+
[ClickHouse Cloud OpenAPI](/cloud/managed-postgres/openapi#query-insights)を通じて
175+
プログラムからも利用できます。
176+
[低速パターン](#slow-patterns) テーブルは
177+
[list slow query patterns](https://clickhouse.com/docs/cloud/manage/api/swagger#tag/Postgres/operation/slowQueryPatternsGetList)
178+
エンドポイントに対応し、[詳細フライアウト](#detail)
179+
[get slow query pattern](https://clickhouse.com/docs/cloud/manage/api/swagger#tag/Postgres/operation/slowQueryPatternGet)
180+
エンドポイントに対応しています。このエンドポイントは、1 つのパターンの集計メトリクスと
181+
その最近の実行結果を返します。
182+
171183
## 仕組み \{#how-it-works\}
172184

173185
### ネットワークに出る前に、Postgres で正規化 \{#how-normalized\}
@@ -206,5 +218,6 @@ ClickHouse に送信できます。ソースコードと issue は
206218

207219
* [監視ダッシュボード](/cloud/managed-postgres/monitoring/dashboard) — 組み込みのリソースとアクティビティのチャート
208220
* [Prometheus エンドポイント](/cloud/managed-postgres/monitoring/prometheus) — ホストレベルのメトリクスを独自のオブザーバビリティスタックにスクレイプして取り込む
221+
* [Managed Postgres OpenAPI](/cloud/managed-postgres/openapi#query-insights) — 低速パターンと最近の実行をプログラムからクエリする
209222
* [拡張機能](/cloud/managed-postgres/extensions) — Managed Postgres インスタンスで利用できる拡張機能
210223
* [`pg_stat_ch` on GitHub](https://github.com/clickhouse/pg_stat_ch) — クエリインサイト を支えるオープンソースの拡張機能

i18n/jp/docusaurus-plugin-content-docs/current/cloud/managed-postgres/openapi.md

Lines changed: 136 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ slug: /cloud/managed-postgres/openapi
33
sidebar_label: 'OpenAPI'
44
title: 'Managed Postgres OpenAPI'
55
description: 'OpenAPI を使用して Managed Postgres サービスをプログラムで制御します'
6-
keywords: ['managed postgres', 'openapi', 'api', 'curl', 'チュートリアル', 'コマンドライン']
6+
keywords: ['managed postgres', 'openapi', 'api', 'curl', 'チュートリアル', 'コマンドライン', 'クエリインサイト', '低速クエリ']
77
doc_type: 'guide'
88
---
99

@@ -280,8 +280,130 @@ curl -sX DELETE --user "$KEY_ID:$KEY_SECRET" \
280280
Prometheus 互換の 2 つのエンドポイントで、Managed Postgres サービスの CPU、メモリ、I/O、接続、
281281
およびトランザクションのメトリクスを公開します。1 つは組織内のすべてのサービスの
282282
メトリクスを返し、もう 1 つは単一のサービスのメトリクスを返します。
283-
設定については [Prometheus endpoint] ページを、メトリクスの完全な一覧については
284-
[metrics reference] を参照してください。
283+
設定については [Prometheus エンドポイント] ページを、メトリクスの完全な一覧については
284+
[メトリクス リファレンス] を参照してください。
285+
286+
## クエリインサイト \{#query-insights\}
287+
288+
cloud
289+
コンソールの [Query Insights] タブで利用されているステートメント単位のテレメトリーは、プログラムからも利用できます。2 つのエンドポイントにより、サービス上で最も遅い
290+
クエリパターンが公開されています。一方は影響度順にすべてのパターンを一覧表示し、もう一方は単一のパターンとその最近の実行結果を返します。
291+
292+
### 遅いクエリパターンを一覧表示する \{#list-slow-query-patterns\}
293+
294+
[スローパターン API] は、一定期間内に観測された最も遅いクエリ
295+
パターンの集計メトリクスを返します。この期間の指定は必須です。RFC 3339 のタイムスタンプとして
296+
`from_date``to_date` を渡してください。
297+
298+
```bash
299+
FROM=2026-05-25T00:00:00Z
300+
TO=2026-05-26T00:00:00Z
301+
302+
curl -s --user "$KEY_ID:$KEY_SECRET" \
303+
"https://api.clickhouse.cloud/v1/organizations/$ORG_ID/postgres/$PG_ID/slowQueryPatterns?from_date=$FROM&to_date=$TO" \
304+
| jq
305+
```
306+
307+
結果はデフォルトで、`total_duration` の降順にソートされた、最も負荷の高いパターンから表示されます。`sort_by` を使うと別の項目 (たとえば
308+
`p99_duration``call_count`、または `total_wal_bytes`) でソートでき、`sort_order` で順序を反転できます。`db_name``db_user`
309+
`db_operation``app` のフィルターで対象を絞り込み、`limit`
310+
`offset` でページ送りできます。
311+
312+
各結果は 1 つの正規化されたパターンで、リテラルは除去され、
313+
実行時間はマイクロ秒単位で表示されます:
314+
315+
```json
316+
{
317+
"result": [
318+
{
319+
"queryId": "-4748036479882663975",
320+
"queryText": "SELECT * FROM orders WHERE customer_id = $1 ORDER BY created_at DESC LIMIT $2",
321+
"dbName": "sales",
322+
"dbUser": "orders_service",
323+
"dbOperation": "SELECT",
324+
"app": "orders-api",
325+
"callCount": 84213,
326+
"errorCount": 0,
327+
"totalDurationUs": 1012384556,
328+
"avgDurationUs": 12021,
329+
"maxDurationUs": 482915,
330+
"p50DurationUs": 9874,
331+
"p95DurationUs": 28431,
332+
"p99DurationUs": 41200,
333+
"totalRows": 842130,
334+
"totalSharedBlksRead": 19284,
335+
"totalSharedBlksHit": 48217734,
336+
"totalCpuTimeUs": 938472113,
337+
"totalWalBytes": 0
338+
}
339+
],
340+
"requestId": "c128d830-5769-4c82-8235-f79aa69d1ebf",
341+
"status": 200
342+
}
343+
```
344+
345+
`queryId` は正規化されたステートメントの符号付き 64 ビットハッシュなので、
346+
負の値になることがよくあります。先頭の `-` も含めてそのまま渡すことで、
347+
1 つのパターンを取得できます。
348+
349+
### 遅いクエリパターンを取得する \{#get-slow-query-pattern\}
350+
351+
リストレスポンスの `queryId`[slow pattern API] に渡すと、その
352+
パターンの集計メトリクスと直近の個別の実行結果を取得できます。
353+
パターンの識別に必要な `db_name``db_user``db_operation`
354+
必須です:
355+
356+
```bash
357+
QUERY_ID=-4748036479882663975
358+
359+
curl -s --user "$KEY_ID:$KEY_SECRET" \
360+
"https://api.clickhouse.cloud/v1/organizations/$ORG_ID/postgres/$PG_ID/slowQueryPatterns/$QUERY_ID?db_name=sales&db_user=orders_service&db_operation=SELECT" \
361+
| jq
362+
```
363+
364+
レスポンスには、一覧エンドポイントと同じ集計が
365+
`aggregate` に含まれ、それに加えて `recentExecutions` 配列が含まれます。各実行には、
366+
実行ごとの完全なカウンター — shared および temp block の I/O、CPU の user time と system
367+
time、parallel workers、JIT、WAL — が含まれており、これらは
368+
コンソールの [detail flyout] で内訳が表示されるものと同じカウンターです:
369+
370+
```json
371+
{
372+
"result": {
373+
"aggregate": {
374+
"queryId": "-4748036479882663975",
375+
"queryText": "SELECT * FROM orders WHERE customer_id = $1 ORDER BY created_at DESC LIMIT $2",
376+
"dbName": "sales",
377+
"dbUser": "orders_service",
378+
"dbOperation": "SELECT",
379+
"callCount": 84213,
380+
"avgDurationUs": 12021,
381+
"p99DurationUs": 41200
382+
},
383+
"recentExecutions": [
384+
{
385+
"timestamp": "2026-05-25T16:42:09Z",
386+
"durationUs": 41200,
387+
"rows": 10,
388+
"sharedBlksHit": 412,
389+
"sharedBlksRead": 3,
390+
"tempBlksWritten": 0,
391+
"cpuUserTimeUs": 38211,
392+
"cpuSysTimeUs": 1044,
393+
"parallelWorkersPlanned": 0,
394+
"parallelWorkersLaunched": 0,
395+
"walBytes": 0,
396+
"serverRole": "primary"
397+
}
398+
]
399+
},
400+
"requestId": "a5957990-dbe5-46fd-b5ce-a7f8f79e50fe",
401+
"status": 200
402+
}
403+
```
404+
405+
この例では、簡潔さのために両方のオブジェクトを省略しています。API は
406+
[per-execution counters] に記載されている完全なカウンターセットを返します。
285407

286408
[ClickHouse OpenAPI]: /cloud/manage/cloud-api "Cloud API"
287409

@@ -309,4 +431,14 @@ Prometheus 互換の 2 つのエンドポイントで、Managed Postgres サー
309431

310432
[Prometheus endpoint]: /cloud/managed-postgres/monitoring/prometheus "Managed Postgres の Prometheus エンドポイント"
311433

312-
[metrics reference]: /cloud/managed-postgres/monitoring/metrics "Managed Postgres メトリクスリファレンス"
434+
[metrics reference]: /cloud/managed-postgres/monitoring/metrics "Managed Postgres メトリクスリファレンス"
435+
436+
[Query Insights]: /cloud/managed-postgres/monitoring/query-insights "Postgres クエリインサイト"
437+
438+
[detail flyout]: /cloud/managed-postgres/monitoring/query-insights#detail "クエリインサイトの詳細フライアウト"
439+
440+
[per-execution counters]: /cloud/managed-postgres/monitoring/query-insights#counters "クエリインサイトの実行ごとのカウンター"
441+
442+
[スローパターン API]: https://clickhouse.com/docs/cloud/manage/api/swagger#tag/Postgres/operation/slowQueryPatternsGetList "Postgres のスロークエリパターンを一覧表示"
443+
444+
[slow pattern API]: https://clickhouse.com/docs/cloud/manage/api/swagger#tag/Postgres/operation/slowQueryPatternGet "直近の実行を含む Postgres のスロークエリパターンを取得"

i18n/ko/docusaurus-plugin-content-docs/current/cloud/managed-postgres/monitoring/query-insights.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -170,6 +170,18 @@ Application, Blks hit, CPU user, CPU sys, PID를 추가할 수 있습니다. 이
170170
느린 패턴을 진단하는 데 필요한 모든 정보를 한곳, 한 화면에서
171171
확인할 수 있습니다.
172172

173+
## 쿼리 인사이트 API \{#api\}
174+
175+
동일한 텔레메트리 데이터는
176+
[ClickHouse Cloud OpenAPI](/cloud/managed-postgres/openapi#query-insights)를 통해
177+
프로그래밍 방식으로도 사용할 수 있습니다.
178+
[느린 패턴](#slow-patterns) 테이블은
179+
[list slow query patterns](https://clickhouse.com/docs/cloud/manage/api/swagger#tag/Postgres/operation/slowQueryPatternsGetList)
180+
엔드포인트에 해당하며, [세부 정보 플라이아웃](#detail)
181+
[get slow query pattern](https://clickhouse.com/docs/cloud/manage/api/swagger#tag/Postgres/operation/slowQueryPatternGet)
182+
엔드포인트에 해당합니다. 이 엔드포인트는 단일 패턴의 집계 메트릭과
183+
최근 실행 내역을 함께 반환합니다.
184+
173185
## 작동 원리 \{#how-it-works\}
174186

175187
### 전송 전에 Postgres에서 정규화됩니다 \{#how-normalized\}
@@ -211,5 +223,6 @@ ClickHouse로 전송할 수 있습니다. 소스 코드와 이슈는
211223

212224
* [모니터링 대시보드](/cloud/managed-postgres/monitoring/dashboard) — 기본 제공되는 리소스 및 활동 차트
213225
* [Prometheus 엔드포인트](/cloud/managed-postgres/monitoring/prometheus) — 호스트 수준 메트릭을 자체 관측성 스택으로 스크레이프
226+
* [Managed Postgres OpenAPI](/cloud/managed-postgres/openapi#query-insights) — 느린 패턴과 최근 실행 내역을 프로그래밍 방식으로 조회
214227
* [확장 기능](/cloud/managed-postgres/extensions) — Managed Postgres 인스턴스에서 사용할 수 있는 확장 기능
215228
* [`pg_stat_ch` on GitHub](https://github.com/clickhouse/pg_stat_ch) — 쿼리 인사이트를 구동하는 오픈소스 확장 기능

i18n/ko/docusaurus-plugin-content-docs/current/cloud/managed-postgres/openapi.md

Lines changed: 135 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ slug: /cloud/managed-postgres/openapi
33
sidebar_label: 'OpenAPI'
44
title: 'Managed Postgres OpenAPI'
55
description: 'OpenAPI로 Managed Postgres 서비스를 제어할 수 있습니다'
6-
keywords: ['managed postgres', 'openapi', 'api', 'curl', '튜토리얼', '명령줄']
6+
keywords: ['managed postgres', 'openapi', 'api', 'curl', '튜토리얼', '명령줄', '쿼리 인사이트', '느린 쿼리']
77
doc_type: 'guide'
88
---
99

@@ -285,8 +285,129 @@ curl -sX DELETE --user "$KEY_ID:$KEY_SECRET" \
285285
Prometheus와 호환되는 2개의 엔드포인트가 Managed Postgres 서비스의 CPU, 메모리, I/O, 연결,
286286
및 트랜잭션 메트릭을 노출합니다. 하나는 조직의 모든 서비스에 대한
287287
메트릭을 반환하고, 다른 하나는 단일 서비스에 대한 메트릭을 반환합니다.
288-
설정 방법은 [Prometheus endpoint] 페이지를, 전체 메트릭 목록은
289-
[metrics reference]를 참조하십시오.
288+
설정 방법은 [Prometheus 엔드포인트] 페이지를, 전체 메트릭 목록은
289+
[메트릭 참고]를 참조하십시오.
290+
291+
## 쿼리 인사이트 \{#query-insights\}
292+
293+
Cloud Console의 [쿼리 인사이트] 탭에서 제공되는 SQL 문별 텔레메트리는 프로그래밍 방식으로도 사용할 수 있습니다. 2개의 엔드포인트가 서비스의 가장 느린 쿼리 패턴을 제공합니다. 하나는 영향도 순으로 모든 패턴을 나열하고, 다른 하나는 최근 실행 내역과 함께 단일 패턴을 반환합니다.
294+
295+
### 느린 쿼리 패턴 목록 \{#list-slow-query-patterns\}
296+
297+
[slow patterns API]는 지정된 시간 범위 동안 관찰된 가장 느린 쿼리
298+
패턴의 집계 메트릭을 반환합니다. 시간 범위는 필수이므로
299+
RFC 3339 타임스탬프 형식의 `from_date``to_date`를 전달하십시오:
300+
301+
```bash
302+
FROM=2026-05-25T00:00:00Z
303+
TO=2026-05-26T00:00:00Z
304+
305+
curl -s --user "$KEY_ID:$KEY_SECRET" \
306+
"https://api.clickhouse.cloud/v1/organizations/$ORG_ID/postgres/$PG_ID/slowQueryPatterns?from_date=$FROM&to_date=$TO" \
307+
| jq
308+
```
309+
310+
결과는 기본적으로 `total_duration` 내림차순으로 정렬되며, 비용이 높은 패턴이 먼저 표시됩니다. `sort_by`로 다른 카운터(예:
311+
`p99_duration`, `call_count`, `total_wal_bytes`)를 기준으로 정렬할 수 있고, `sort_order`로 정렬 방향을
312+
반대로 바꿀 수 있습니다. `db_name`, `db_user`,
313+
`db_operation`, `app` 필터로 범위를 좁히고, `limit`
314+
`offset`으로 페이지를 나눠 볼 수 있습니다.
315+
316+
각 결과는 리터럴이 제거된 정규화된 패턴 1개이며, 지속 시간은 마이크로초 단위로
317+
표시됩니다:
318+
319+
```json
320+
{
321+
"result": [
322+
{
323+
"queryId": "-4748036479882663975",
324+
"queryText": "SELECT * FROM orders WHERE customer_id = $1 ORDER BY created_at DESC LIMIT $2",
325+
"dbName": "sales",
326+
"dbUser": "orders_service",
327+
"dbOperation": "SELECT",
328+
"app": "orders-api",
329+
"callCount": 84213,
330+
"errorCount": 0,
331+
"totalDurationUs": 1012384556,
332+
"avgDurationUs": 12021,
333+
"maxDurationUs": 482915,
334+
"p50DurationUs": 9874,
335+
"p95DurationUs": 28431,
336+
"p99DurationUs": 41200,
337+
"totalRows": 842130,
338+
"totalSharedBlksRead": 19284,
339+
"totalSharedBlksHit": 48217734,
340+
"totalCpuTimeUs": 938472113,
341+
"totalWalBytes": 0
342+
}
343+
],
344+
"requestId": "c128d830-5769-4c82-8235-f79aa69d1ebf",
345+
"status": 200
346+
}
347+
```
348+
349+
`queryId`는 정규화된 SQL 문(statement)의 부호 있는 64비트 해시이므로
350+
대개 음수입니다. 단일 패턴을 가져오려면 앞의 `-`를 포함해
351+
값을 그대로 다시 전달하십시오.
352+
353+
### 느린 쿼리 패턴 가져오기 \{#get-slow-query-pattern\}
354+
355+
목록 응답의 `queryId`[slow pattern API]에 전달하면 해당
356+
패턴의 집계 메트릭과 함께 가장 최근의 개별 실행 기록을 가져올 수 있습니다.
357+
패턴을 식별하는 `db_name`, `db_user`, `db_operation`
358+
필수입니다:
359+
360+
```bash
361+
QUERY_ID=-4748036479882663975
362+
363+
curl -s --user "$KEY_ID:$KEY_SECRET" \
364+
"https://api.clickhouse.cloud/v1/organizations/$ORG_ID/postgres/$PG_ID/slowQueryPatterns/$QUERY_ID?db_name=sales&db_user=orders_service&db_operation=SELECT" \
365+
| jq
366+
```
367+
368+
응답에는 목록 엔드포인트와 동일한 집계가 `aggregate` 아래에 포함되며,
369+
여기에 `recentExecutions` 배열이 추가됩니다. 각 실행에는
370+
공유 및 임시 블록 I/O, CPU 사용자 및 시스템
371+
시간, 병렬 workers, JIT, WAL을 비롯한 실행별 전체 카운터가 포함되며, 이는
372+
콘솔에서 [detail flyout]이 세부적으로 보여주는 카운터와 동일합니다:
373+
374+
```json
375+
{
376+
"result": {
377+
"aggregate": {
378+
"queryId": "-4748036479882663975",
379+
"queryText": "SELECT * FROM orders WHERE customer_id = $1 ORDER BY created_at DESC LIMIT $2",
380+
"dbName": "sales",
381+
"dbUser": "orders_service",
382+
"dbOperation": "SELECT",
383+
"callCount": 84213,
384+
"avgDurationUs": 12021,
385+
"p99DurationUs": 41200
386+
},
387+
"recentExecutions": [
388+
{
389+
"timestamp": "2026-05-25T16:42:09Z",
390+
"durationUs": 41200,
391+
"rows": 10,
392+
"sharedBlksHit": 412,
393+
"sharedBlksRead": 3,
394+
"tempBlksWritten": 0,
395+
"cpuUserTimeUs": 38211,
396+
"cpuSysTimeUs": 1044,
397+
"parallelWorkersPlanned": 0,
398+
"parallelWorkersLaunched": 0,
399+
"walBytes": 0,
400+
"serverRole": "primary"
401+
}
402+
]
403+
},
404+
"requestId": "a5957990-dbe5-46fd-b5ce-a7f8f79e50fe",
405+
"status": 200
406+
}
407+
```
408+
409+
예시에서는 간결하게 보여주기 위해 두 객체를 모두 일부만 표시했으며, API는
410+
[per-execution counters]에 문서화된 전체 카운터 세트를 반환합니다.
290411

291412
[ClickHouse OpenAPI]: /cloud/manage/cloud-api "Cloud API"
292413

@@ -314,4 +435,14 @@ Prometheus와 호환되는 2개의 엔드포인트가 Managed Postgres 서비스
314435

315436
[Prometheus endpoint]: /cloud/managed-postgres/monitoring/prometheus "Managed Postgres Prometheus 엔드포인트"
316437

317-
[metrics reference]: /cloud/managed-postgres/monitoring/metrics "Managed Postgres 메트릭 참고"
438+
[metrics reference]: /cloud/managed-postgres/monitoring/metrics "Managed Postgres 메트릭 참고"
439+
440+
[Query Insights]: /cloud/managed-postgres/monitoring/query-insights "Postgres 쿼리 인사이트"
441+
442+
[detail flyout]: /cloud/managed-postgres/monitoring/query-insights#detail "쿼리 인사이트 세부 정보 플라이아웃"
443+
444+
[per-execution counters]: /cloud/managed-postgres/monitoring/query-insights#counters "쿼리 인사이트 실행별 카운터"
445+
446+
[slow patterns API]: https://clickhouse.com/docs/cloud/manage/api/swagger#tag/Postgres/operation/slowQueryPatternsGetList "Postgres 느린 쿼리 패턴 목록 조회"
447+
448+
[slow pattern API]: https://clickhouse.com/docs/cloud/manage/api/swagger#tag/Postgres/operation/slowQueryPatternGet "최근 실행 기록과 함께 Postgres 느린 쿼리 패턴 조회"

0 commit comments

Comments
 (0)