Embed public Beam IO Performance Metrics (#27540)

* Use shortcodes to render looks * Add performance looks * Fix performance/index * Use pngs stored in GCS * Fix textio wording * Remove navigation header * Add links to metrics * Trim metrics list
apache · Jul 20, 2023 · 549bbfc · 549bbfc
1 parent 2c59a74
commit 549bbfc
Show file tree

Hide file tree

Showing 10 changed files with 429 additions and 4 deletions.
diff --git a/website/www/site/content/en/documentation/io/connectors.md b/website/www/site/content/en/documentation/io/connectors.md
@@ -79,7 +79,7 @@ This table provides a consolidated, at-a-glance overview of the available built-
     <td class="present">✔</td>
   </tr>
   <tr>
-    <td>TextIO</td>
+    <td>TextIO (<a href="/performance/textio">metrics</a>)</td>
     <td class="present">✔</td>
     <td class="present">✔</td>
     <td class="present">
@@ -200,7 +200,7 @@ This table provides a consolidated, at-a-glance overview of the available built-
     <td class="absent">✘</td>
   </tr>
   <tr>
-    <td>GcsFileSystem</td>
+    <td>GcsFileSystem (<a href="/performance/textio">metrics</a>)</td>
     <td class="present">✔</td>
     <td class="present">✔</td>
     <td class="present">
@@ -522,7 +522,7 @@ This table provides a consolidated, at-a-glance overview of the available built-
     <td class="present">✔</td>
   </tr>
   <tr>
-    <td>BigQueryIO (<a href="/documentation/io/built-in/google-bigquery/">guide</a>)</td>
+    <td>BigQueryIO (<a href="/documentation/io/built-in/google-bigquery/">guide</a>) (<a href="/performance/bigquery">metrics</a>)</td>
     <td class="present">✔</td>
     <td class="present">✔</td>
     <td class="present">
@@ -545,7 +545,7 @@ This table provides a consolidated, at-a-glance overview of the available built-
     <td class="present">✔</td>
   </tr>
   <tr>
-    <td>BigTableIO</td>
+    <td>BigTableIO (<a href="/performance/bigtable">metrics</a>)</td>
     <td class="present">✔</td>
     <td class="present">✔</td>
     <td class="present">

diff --git a/website/www/site/content/en/performance/_index.md b/website/www/site/content/en/performance/_index.md
@@ -0,0 +1,40 @@
+---
+title: "Beam IO Performance"
+---
+
+<!--
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+-->
+
+# Beam IO Performance
+
+Various Beam pipelines measure characteristics of reading from and writing to
+various IOs.
+
+# Available Metrics
+
+Various metrics were gathered using the Beam SDK
+[Metrics API](/documentation/programming-guide/#metrics)
+from a pipeline Job running on [Dataflow](/documentation/runners/dataflow/).
+
+See the [glossary](/performance/glossary) for a list of the metrics and their
+definition.
+
+# Measured Beam IOs
+
+See the following pages for performance measures recorded when reading from and
+writing to various Beam IOs.
+
+- [BigQuery](/performance/bigquery)
+- [BigTable](/performance/bigtable)
+- [TextIO](/performance/textio)
diff --git a/website/www/site/content/en/performance/bigquery/_index.md b/website/www/site/content/en/performance/bigquery/_index.md
@@ -0,0 +1,50 @@
+---
+title: "BigQuery Performance"
+---
+
+<!--
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+-->
+
+# BigQuery Performance
+
+The following graphs show various metrics when reading from and writing to
+BigQuery. See the [glossary](/performance/glossary) for definitions.
+
+## Read
+
+### What is the estimated cost to read from BigQuery?
+
+{{< performance_looks io="bigquery" read_or_write="read" section="test_name" >}}
+
+### How has various metrics changed when reading from BigQuery for different Beam SDK versions?
+
+{{< performance_looks io="bigquery" read_or_write="read" section="version" >}}
+
+### How has various metrics changed over time when reading from BigQuery?
+
+{{< performance_looks io="bigquery" read_or_write="read" section="date" >}}
+
+## Write
+
+### What is the estimated cost to write to BigQuery?
+
+{{< performance_looks io="bigquery" read_or_write="write" section="test_name" >}}
+
+### How has various metrics changed when writing to BigQuery for different Beam SDK versions?
+
+{{< performance_looks io="bigquery" read_or_write="write" section="version" >}}
+
+### How has various metrics changed over time when writing to BigQuery?
+
+{{< performance_looks io="bigquery" read_or_write="write" section="date" >}}
diff --git a/website/www/site/content/en/performance/bigtable/_index.md b/website/www/site/content/en/performance/bigtable/_index.md
@@ -0,0 +1,50 @@
+---
+title: "BigTable Performance"
+---
+
+<!--
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+-->
+
+# BigTable Performance
+
+The following graphs show various metrics when reading from and writing to
+BigTable. See the [glossary](/performance/glossary) for definitions.
+
+## Read
+
+### What is the estimated cost to read from BigTable?
+
+{{< performance_looks io="bigquery" read_or_write="read" section="test_name" >}}
+
+### How has various metrics changed when reading from BigTable for different Beam SDK versions?
+
+{{< performance_looks io="bigquery" read_or_write="read" section="version" >}}
+
+### How has various metrics changed over time when reading from BigTable?
+
+{{< performance_looks io="bigquery" read_or_write="read" section="date" >}}
+
+## Write
+
+### What is the estimated cost to write to BigTable?
+
+{{< performance_looks io="bigquery" read_or_write="write" section="test_name" >}}
+
+### How has various metrics changed when writing to BigTable for different Beam SDK versions?
+
+{{< performance_looks io="bigquery" read_or_write="write" section="version" >}}
+
+### How has various metrics changed over time when writing to BigTable?
+
+{{< performance_looks io="bigquery" read_or_write="write" section="date" >}}
diff --git a/website/www/site/content/en/performance/glossary/_index.md b/website/www/site/content/en/performance/glossary/_index.md
@@ -0,0 +1,47 @@
+---
+title: "Performance Glossary"
+---
+
+<!--
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+-->
+
+# Metrics Glossary
+
+The metrics glossary defines various metrics presented in the visualizations,
+measured using the [Beam Metrics API](/documentation/programming-guide/#metrics)
+from a pipeline Job running on [Dataflow](/documentation/runners/dataflow/).
+
+## AvgInputThroughputBytesPerSec
+
+The mean input throughput of the pipeline Job measured in bytes per second.
+
+## AvgInputThroughputElementsPerSec
+
+The mean elements input throughput per second of the pipeline Job.
+
+## AvgOutputThroughputBytesPerSec
+
+The mean output throughput of the pipeline Job measured in bytes per second.
+
+## AvgOutputThroughputElementsPerSec
+
+The mean elements output throughput per second of the pipeline Job.
+
+## EstimatedCost
+
+The estimated cost of the pipeline Job.
+
+## RunTime
+
+The time it took for the pipeline Job to run measured in seconds.
diff --git a/website/www/site/content/en/performance/textio/_index.md b/website/www/site/content/en/performance/textio/_index.md
@@ -0,0 +1,50 @@
+---
+title: "TextIO Performance"
+---
+
+<!--
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+-->
+
+# TextIO Performance
+
+The following graphs show various metrics when reading from or writing to Google Cloud Storage using
+TextIO. See the [glossary](/performance/glossary) for definitions.
+
+## Read
+
+### What is the estimated cost of reading from Google Cloud Storage using TextIO?
+
+{{< performance_looks io="textio" read_or_write="read" section="test_name" >}}
+
+### How has various metrics changed when reading from Google Cloud Storage using TextIO for different Beam SDK versions?
+
+{{< performance_looks io="textio" read_or_write="read" section="version" >}}
+
+### How has various metrics changed over time when reading from Google Cloud Storage using TextIO?
+
+{{< performance_looks io="textio" read_or_write="read" section="date" >}}
+
+## Write
+
+### What is the estimated cost of writing to Google Cloud Storage using TextIO?
+
+{{< performance_looks io="textio" read_or_write="write" section="test_name" >}}
+
+### How has various metrics changed when writing to Google Cloud Storage using TextIO for different Beam SDK versions?
+
+{{< performance_looks io="textio" read_or_write="write" section="version" >}}
+
+### How has various metrics changed over time when writing to Google Cloud Storage using TextIO?
+
+{{< performance_looks io="textio" read_or_write="write" section="date" >}}
diff --git a/website/www/site/data/performance.yaml b/website/www/site/data/performance.yaml
@@ -0,0 +1,108 @@
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+host: https://storage.googleapis.com
+path: public_looker_explores_us_a3853f40
+looks:
+  bigquery:
+    read:
+      folder: 30
+      test_name:
+        - id: nwQxvsnQFdBPTk27pZYxjcGNm2rRfNJk
+          title: Runtime and Estimated Cost by Test Name
+      date:
+        - id: 7QKbMmgT5NgPH6RsDfVQmKMdjJysS37x
+          title: AvgOutputThroughputBytesPerSec by Date
+        - id: hSqCyCkHkh4whNZSpdVFwB8ksPWrbScb
+          title: AvgOutputThroughputElementsPerSec by Date
+      version:
+        - id: SghzxqjMb5QQwgZn7yHw4MnpGXBgXQft
+          title: AvgOutputThroughputBytesPerSec by Version
+        - id: QT6X4GTCnxxykSZ7tpXyBfBFCKMgdzs7
+          title: AvgOutputThroughputElementsPerSec by Version
+    write:
+      folder: 31
+      test_name:
+        - id: sHyRfwCfGCPqSwsTWXSsxfbHKH5hXjzc
+          title: Write BigQuery RunTime and EstimatedCost
+      date:
+        - id: p2qnxS58WdWdZTzJhXfSbkhxGyDXMYfY
+          title: AvgInputThroughputBytesPerSec by Date
+        - id: Bmg6sv8XPtcn3cGtgPtKP26Zj4cyd2XK
+          title: AvgInputThroughputElementsPerSec by Date
+      version:
+        - id: Q6QvktyfSFrSPq4TSDgQQyV9jttjwQJp
+          title: AvgInputThroughputBytesPerSec by Version
+        - id: ktfyZ7Th8yRFFwWgb4WSxngBpmSfz8xh
+          title: AvgInputThroughputElementsPerSec by Version
+  bigtable:
+    read:
+      folder: 32
+      test_name:
+        - id: YQ2W3wdNnBXMgDgpzCRbmQWMHjyPvZny
+          title: Read BigTable RunTime and EstimatedCost
+      date:
+        - id: szvwNfPrwTtmRmMHWv3QFh6wTKxm26TF
+          title: AvgOutputThroughputBytesPerSec by Date
+        - id: ZRQw7np2mj35kQHcvgtNDwVGgP855QNF
+          title: AvgOutputThroughputElementsPerSec by Date
+      version:
+        - id: X7y2hQQkJnYY8ctnr2y7NnNx7xrMkjt2
+          title: AvgOutputThroughputBytesPerSec by Version
+        - id: B3HwmTtn9nBfzwRC7s3WfQSjf7ckrfXx
+          title: AvgOutputThroughputElementsPerSec by Version
+    write:
+      folder: 33
+      test_name:
+        - id: 2sC27RQwWy2MP9DXVHjbvTYSNFYpFvxj
+          title: Write BigTable RunTime and EstimatedCost
+      date:
+      - id: X22sDqD8krBQQ4mRXTFMmpKFvgkZ529g
+        title: AvgInputThroughputBytesPerSec by Date
+      - id: WqHVhrjQVrrjpczqgJB9s9k8fvt3Vc2d
+        title: AvgInputThroughputElementsPerSec by Date
+      version:
+      - id: j72shCBz6rJhQP8JwYB3JcVrhv9BWGpD
+        title: AvgInputThroughputBytesPerSec by Version
+      - id: 6DyhkfvcNfkJg53hwFnRzxqbJDdGb5t7
+        title: AvgInputThroughputElementsPerSec by Version
+  textio:
+    read:
+      folder: 34
+      test_name:
+        - id: SsfFgvwyMthnHjdRwBjWGNbvfNgym4wb
+          title: Read TextIO RunTime and EstimatedCost
+      date:
+        - id: Pr8MBG66JVgBmdQbDr6HXtRprjr3ybj6
+          title: AvgOutputThroughputBytesPerSec by Date
+        - id: CTZYK4KVYM65Zjn6jWgDYYNBWckDYKRQ
+          title: AvgOutputThroughputElementsPerSec by Date
+      version:
+        - id: Dcvfh3XFZySrsmPY4Rm8NYyMg5QQRBF6
+          title: AvgOutputThroughputBytesPerSec by Version
+        - id: dN8mTZsVZc7vGDYKJCT8S67BCXzVJT4s
+          title: AvgOutputThroughputElementsPerSec by Version
+    write:
+      folder: 35
+      test_name:
+        - id: Mm2j2QPc2x4hZqYNSpZC4bDpH2fgvqvp
+          title: Write TextIO RunTime and EstimatedCost
+      date:
+      - id: J9VXhp3ry5zbPFFGsYNfDRypGNVNMbPV
+        title: AvgInputThroughputBytesPerSec by Date
+      - id: KwSCnyz75wMpXhGpZQ8FRp6cwt8pjhfD
+        title: AvgInputThroughputElementsPerSec by Date
+      version:
+      - id: VFXbPV9JGJxmNYnGsypQzH97RPDFjpPN
+        title: AvgInputThroughputBytesPerSec by Version
+      - id: fVVHhXCrHNgBG52TJsTjR8VbmWCCQnVN
+        title: AvgInputThroughputElementsPerSec by Version