Update metrics documentation for Cloud Monitoring/Stackdriver #2862

junninho · 2022-12-09T17:56:49Z

What type of PR is this?

Uncomment only one /kind <> line, press enter to put that in a new line, and remove leading whitespace from that line:

/kind breaking
/kind bug
/kind cleanup

/kind documentation

/kind feature
/kind hotfix

What this PR does / Why we need it:

Update Stackdriver references to Cloud Monitoring
Include missing steps to get Cloud Monitoring up and running
Add step to resolution for the error mentioned in the troubleshooting section

Which issue(s) this PR fixes:
Closes #2850

Special notes for your reviewer:

- Update Stackdriver references to Cloud Monitoring - Include missing steps to get Cloud Monitoring up and running - Add step to resolution for the error mentioned in the troubleshooting section

junninho · 2022-12-09T18:11:38Z

/assign @markmandel

agones-bot · 2022-12-09T18:26:57Z

Build Failed 😱

Build Id: 041ec12d-a796-466e-84ff-f1a9f167e489

To get permission to view the Cloud Build view, join the agones-discuss Google Group.

markmandel · 2022-12-10T00:09:05Z

Looks like your docs change have introduced a broken link unfortunately:

site/docs/guides/metrics/index.html
  hash does not exist --- site/docs/guides/metrics/index.html --> #stackdriver-installation

roberthbailey · 2022-12-10T03:07:14Z

Looks like an error was caught by htmltest:

htmltest started at 06:05:57 on /tmp/website
========================================================================
site/docs/guides/metrics/index.html
  hash does not exist --- site/docs/guides/metrics/index.html --> #stackdriver-installation

agones-bot · 2022-12-10T03:35:49Z

Build Failed 😱

Build Id: b01701d8-6e16-4c24-8476-27b4ae60b9bf

To get permission to view the Cloud Build view, join the agones-discuss Google Group.

Fix broken link Update additional stackdriver references

agones-bot · 2022-12-12T19:57:23Z

Build Succeeded 👏

Build Id: 44304477-01a7-4fbd-ac87-93c669c84956

The following development artifacts have been built, and will exist for the next 30 days:

image: us-docker.pkg.dev/agones-images/ci/agones-controller:1.29.0-07fd48a-amd64
image: us-docker.pkg.dev/agones-images/ci/agones-sdk:1.29.0-07fd48a-linux-amd64
image: us-docker.pkg.dev/agones-images/ci/agones-ping:1.29.0-07fd48a-amd64
image: us-docker.pkg.dev/agones-images/ci/agones-allocator:1.29.0-07fd48a-amd64
Linux C++ SDK (build): agonessdk-1.29.0-07fd48a-amd64-linux-arch_64.tar.gz
SDK Server: agonessdk-server-1.29.0-07fd48a-amd64.zip

A preview of the website (the last 30 builds are retained):

https://07fd48a-dot-preview-dot-agones-images.appspot.com/

To install this version:

git fetch https://github.com/googleforgames/agones.git pull/2862/head:pr_2862 && git checkout pr_2862
helm install agones ./install/helm/agones --namespace agones-system --set agones.image.tag=1.29.0-07fd48a-amd64

aimuz

Looks good

site/content/en/docs/Guides/metrics.md

Co-authored-by: aimuz <[email protected]>

agones-bot · 2022-12-13T16:37:53Z

Build Succeeded 👏

Build Id: 7262a8df-6b0e-4ccd-a4cd-01e4e884a0f7

The following development artifacts have been built, and will exist for the next 30 days:

image: us-docker.pkg.dev/agones-images/ci/agones-controller:1.29.0-1cc9a3b-amd64
image: us-docker.pkg.dev/agones-images/ci/agones-sdk:1.29.0-1cc9a3b-linux-amd64
image: us-docker.pkg.dev/agones-images/ci/agones-ping:1.29.0-1cc9a3b-amd64
image: us-docker.pkg.dev/agones-images/ci/agones-allocator:1.29.0-1cc9a3b-amd64
Linux C++ SDK (build): agonessdk-1.29.0-1cc9a3b-amd64-linux-arch_64.tar.gz
SDK Server: agonessdk-server-1.29.0-1cc9a3b-amd64.zip

A preview of the website (the last 30 builds are retained):

https://1cc9a3b-dot-preview-dot-agones-images.appspot.com/

To install this version:

git fetch https://github.com/googleforgames/agones.git pull/2862/head:pr_2862 && git checkout pr_2862
helm install agones ./install/helm/agones --namespace agones-system --set agones.image.tag=1.29.0-1cc9a3b-amd64

aimuz · 2022-12-14T01:44:34Z

LGTM

Thank you

markmandel

Thank you for doing this work! This is great. I am worried that section on outputting a yaml file could be confusing though - have a look at my comment and let me know what you think.

markmandel · 2022-12-15T00:32:36Z

site/content/en/docs/Guides/metrics.md

+If you are using the [YAML installation]({{< ref "/docs/Installation/Install Agones/yaml.md" >}}), you will need to update the necessary parameters in the `install.yaml` file using the following commands:

-#### Using Stackdriver with Workload Identity
+```bash
+helm pull --untar https://agones.dev/chart/stable/agones-1.27.0.tgz && \
+cd agones && \
+helm template agones-manual --namespace agones-system  . \
+  --set agones.metrics.stackdriverEnabled=true \
+  --set agones.metrics.prometheusEnabled=false \
+  --set agones.metrics.prometheusServiceDiscovery=false \
+  > install-custom.yaml
+```

-If you would like to enable stackdriver in conjunction with [Workload Identity](https://cloud.google.com/kubernetes-engine/docs/how-to/workload-identity), there are a few extra steps you need to follow:
+```bash
+kubectl apply -f install-custom.yaml
+```


🤔 I'm not sure about this section. I'm kinda figuring it's not necessary and possibly confusing.

If you are using the YAML install, running this command doesn't actually change the install.yaml that is hosted on github for the release - it just gives you an yaml file.

If someone is familiar with Helm and wants a yaml file instead, I would argue it's probably likely they already know how to do this.

If they aren't familiar with Helm, I'd worry this section is confusing. I'd be tempted to drop it.

Hmm I definitely could have phrased that more accurately. Similarly to the Install Agones using YAML page, I do think having some guidance around what to do if you are using YAML would be helpful. An alternative would be to simply add a note linking to this part of the page to change the parameters.

I'm also not opposed to dropping it but let me know what you think.

Personally, I don't see a lot of people finding confusion with generating yaml from Helm -- but it's entirely possible that's a blind spot I have.

An alternative would be to simply add a note linking to this part of the page to change the parameters.

Seems like a good compromise to me 👍🏻 Could even do it as an "Note" box if you want to highlight it, e.g.

agones/site/content/en/docs/Guides/metrics.md

Lines 114 to 116 in 1cc9a3b

{{< alert title="Note" color="info">}}

You can import our dashboards by copying the json content from {{< ghlink href="/build/grafana" branch="main" >}}each config map{{< /ghlink >}} into your own instance of Grafana (+ > Create > Import > Or paste json) or follow the [installation](#installation) guide.

{{< /alert >}}

agones-bot · 2022-12-28T18:19:05Z

Build Failed 😱

Build Id: 97a93300-0faa-45cb-9535-678a4b6718f3

To get permission to view the Cloud Build view, join the agones-discuss Google Group.

Change format to be a note referring to the instructions on the installation page

agones-bot · 2022-12-28T18:58:22Z

Build Succeeded 👏

Build Id: 3f6736b6-c9ce-4292-998d-64280c2256d9

The following development artifacts have been built, and will exist for the next 30 days:

image: us-docker.pkg.dev/agones-images/ci/agones-controller:1.29.0-c815796-amd64
image: us-docker.pkg.dev/agones-images/ci/agones-sdk:1.29.0-c815796-linux-amd64
image: us-docker.pkg.dev/agones-images/ci/agones-ping:1.29.0-c815796-amd64
image: us-docker.pkg.dev/agones-images/ci/agones-allocator:1.29.0-c815796-amd64
Linux C++ SDK (build): agonessdk-1.29.0-c815796-amd64-linux-arch_64.tar.gz
SDK Server: agonessdk-server-1.29.0-c815796-amd64.zip

A preview of the website (the last 30 builds are retained):

https://c815796-dot-preview-dot-agones-images.appspot.com/

To install this version:

git fetch https://github.com/googleforgames/agones.git pull/2862/head:pr_2862 && git checkout pr_2862
helm install agones ./install/helm/agones --namespace agones-system --agones.image.release=us-docker.pkg.dev/agones-images/ci --set agones.image.tag=1.29.0-c815796-amd64

markmandel

Just realised I never came back and approved this. It's good to go!

google-oss-prow · 2023-01-05T22:29:34Z

New changes are detected. LGTM label has been removed.

google-oss-prow · 2023-01-05T22:29:46Z

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: junninho, markmandel

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

~~OWNERS~~ [markmandel]

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

google-oss-prow · 2023-01-05T22:29:46Z

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: junninho, markmandel

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

~~OWNERS~~ [markmandel]

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

agones-bot · 2023-01-05T22:59:28Z

Build Succeeded 👏

Build Id: 7a651389-1ecb-491e-9fca-b65f04f29a09

The following development artifacts have been built, and will exist for the next 30 days:

image: us-docker.pkg.dev/agones-images/ci/agones-controller:1.29.0-1f504ef-amd64
image: us-docker.pkg.dev/agones-images/ci/agones-sdk:1.29.0-1f504ef-linux-amd64
image: us-docker.pkg.dev/agones-images/ci/agones-ping:1.29.0-1f504ef-amd64
image: us-docker.pkg.dev/agones-images/ci/agones-allocator:1.29.0-1f504ef-amd64
Linux C++ SDK (build): agonessdk-1.29.0-1f504ef-amd64-linux-arch_64.tar.gz
SDK Server: agonessdk-server-1.29.0-1f504ef-amd64.zip

A preview of the website (the last 30 builds are retained):

https://1f504ef-dot-preview-dot-agones-images.appspot.com/

To install this version:

git fetch https://github.com/googleforgames/agones.git pull/2862/head:pr_2862 && git checkout pr_2862
helm install agones ./install/helm/agones --namespace agones-system --agones.image.release=us-docker.pkg.dev/agones-images/ci --set agones.image.tag=1.29.0-1f504ef-amd64

Update metrics documentation for Cloud Monitoring/Stackdriver

36cc58d

- Update Stackdriver references to Cloud Monitoring - Include missing steps to get Cloud Monitoring up and running - Add step to resolution for the error mentioned in the troubleshooting section

google-oss-prow bot requested review from EricFortin and markmandel December 9, 2022 17:56

google-oss-prow bot added the size/M label Dec 9, 2022

google-oss-prow bot assigned markmandel Dec 9, 2022

Merge branch 'main' into main

d05c026

junninho added 2 commits December 12, 2022 13:27

Update broken link

8d0cc18

Fix broken link Update additional stackdriver references

Merge branch 'main' of github.com:junninho/agones into main

07fd48a

aimuz reviewed Dec 13, 2022

View reviewed changes

site/content/en/docs/Guides/metrics.md Outdated Show resolved Hide resolved

Update metrics YAML instructions

1cc9a3b

Co-authored-by: aimuz <[email protected]>

markmandel reviewed Dec 15, 2022

View reviewed changes

Merge branch 'googleforgames:main' into main

6f48b4b

Update Cloud Monitoring Metrics YAML section

c815796

Change format to be a note referring to the instructions on the installation page

markmandel approved these changes Jan 5, 2023

View reviewed changes

google-oss-prow bot added the lgtm label Jan 5, 2023

Merge branch 'main' into main

1f504ef

google-oss-prow bot removed the lgtm label Jan 5, 2023

google-oss-prow bot added the approved label Jan 5, 2023

markmandel merged commit 055a0c2 into googleforgames:main Jan 5, 2023

Kalaiselvi84 added this to the 1.29.0 milestone Jan 17, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Update metrics documentation for Cloud Monitoring/Stackdriver #2862

Update metrics documentation for Cloud Monitoring/Stackdriver #2862

junninho commented Dec 9, 2022

junninho commented Dec 9, 2022

agones-bot commented Dec 9, 2022

markmandel commented Dec 10, 2022

roberthbailey commented Dec 10, 2022

agones-bot commented Dec 10, 2022

agones-bot commented Dec 12, 2022

aimuz left a comment

agones-bot commented Dec 13, 2022

aimuz commented Dec 14, 2022

markmandel left a comment

markmandel Dec 15, 2022

junninho Dec 19, 2022

markmandel Dec 19, 2022

agones-bot commented Dec 28, 2022

agones-bot commented Dec 28, 2022

markmandel left a comment

google-oss-prow bot commented Jan 5, 2023

google-oss-prow bot commented Jan 5, 2023

google-oss-prow bot commented Jan 5, 2023

agones-bot commented Jan 5, 2023

	{{< alert title="Note" color="info">}}
	You can import our dashboards by copying the json content from {{< ghlink href="/build/grafana" branch="main" >}}each config map{{< /ghlink >}} into your own instance of Grafana (+ > Create > Import > Or paste json) or follow the [installation](#installation) guide.
	{{< /alert >}}

Update metrics documentation for Cloud Monitoring/Stackdriver #2862

Update metrics documentation for Cloud Monitoring/Stackdriver #2862

Conversation

junninho commented Dec 9, 2022

junninho commented Dec 9, 2022

agones-bot commented Dec 9, 2022

markmandel commented Dec 10, 2022

roberthbailey commented Dec 10, 2022

agones-bot commented Dec 10, 2022

agones-bot commented Dec 12, 2022

aimuz left a comment

Choose a reason for hiding this comment

agones-bot commented Dec 13, 2022

aimuz commented Dec 14, 2022

markmandel left a comment

Choose a reason for hiding this comment

markmandel Dec 15, 2022

Choose a reason for hiding this comment

junninho Dec 19, 2022

Choose a reason for hiding this comment

markmandel Dec 19, 2022

Choose a reason for hiding this comment

agones-bot commented Dec 28, 2022

agones-bot commented Dec 28, 2022

markmandel left a comment

Choose a reason for hiding this comment

google-oss-prow bot commented Jan 5, 2023

google-oss-prow bot commented Jan 5, 2023

google-oss-prow bot commented Jan 5, 2023

agones-bot commented Jan 5, 2023