Adjust documentation about argument for specification of a support bundle's duration (#35278)

This commit is contained in:
Matt Pollard 2023-03-07 08:47:52 +01:00 коммит произвёл GitHub
Родитель 5ef3b7e155
Коммит 9b5020a923
Не найден ключ, соответствующий данной подписи
Идентификатор ключа GPG: 4AEE18F83AFDEB23
5 изменённых файлов: 20 добавлений и 18 удалений

Просмотреть файл

@ -574,13 +574,13 @@ This utility creates a support bundle tarball containing important logs from eac
By default, the command creates the tarball in */tmp*, but you can also have it `cat` the tarball to `STDOUT` for easy streaming over SSH. This is helpful in the case where the web UI is unresponsive or downloading a support bundle from */setup/support* doesn't work. You must use this command if you want to generate an *extended* bundle, containing older logs. You can also use this command to upload the cluster support bundle directly to {% data variables.product.prodname_enterprise %} support.
{% data reusables.enterprise.bundle-utility-period-argument-availability-note %}
To create a standard bundle:
```shell
$ ssh -p 122 admin@HOSTNAME -- 'ghe-cluster-support-bundle -o' > cluster-support-bundle.tgz
```
{% ifversion specify-period-for-support-bundle %}
To create a standard bundle including data from the last 3 hours:
```shell
$ ssh -p 122 admin@HOSTNAME -- "ghe-cluster-support-bundle -p '3 hours' -o" > support-bundle.tgz
@ -596,9 +596,8 @@ To create a standard bundle including data from the last 4 days and 8 hours:
$ ssh -p 122 admin@HOSTNAME -- "ghe-cluster-support-bundle -p '4 days 8 hours' -o" > support-bundle.tgz
```
{% endif %}
To create an extended bundle including data from the last 8 days:
To create an extended bundle:
```shell
$ ssh -p 122 admin@HOSTNAME -- ghe-cluster-support-bundle -x -o' > cluster-support-bundle.tgz
```
@ -834,13 +833,13 @@ This utility creates a support bundle tarball containing important logs from you
By default, the command creates the tarball in */tmp*, but you can also have it `cat` the tarball to `STDOUT` for easy streaming over SSH. This is helpful in the case where the web UI is unresponsive or downloading a support bundle from */setup/support* doesn't work. You must use this command if you want to generate an *extended* bundle, containing older logs. You can also use this command to upload the support bundle directly to {% data variables.product.prodname_enterprise %} support.
{% data reusables.enterprise.bundle-utility-period-argument-availability-note %}
To create a standard bundle:
```shell
$ ssh -p 122 admin@HOSTNAME -- 'ghe-support-bundle -o' > support-bundle.tgz
```
{% ifversion specify-period-for-support-bundle %}
To create a standard bundle including data from the last 3 hours:
```shell
$ ssh -p 122 admin@HOSTNAME -- "ghe-support-bundle -p '3 hours' -o" > support-bundle.tgz
@ -856,9 +855,7 @@ To create a standard bundle including data from the last 4 days and 8 hours:
$ ssh -p 122 admin@HOSTNAME -- "ghe-support-bundle -p '4 days 8 hours' -o" > support-bundle.tgz
```
{% endif %}
To create an extended bundle:
To create an extended bundle including data from the last 8 days:
```shell
$ ssh -p 122 admin@HOSTNAME -- 'ghe-support-bundle -x -o' > support-bundle.tgz
```

Просмотреть файл

@ -23,8 +23,8 @@ To help you troubleshoot issues with a {% data variables.product.prodname_ghe_se
| Data | File format | Description |
| :- | :- | :- |
| Diagnostic file | Plaintext | Contains information about the instance's settings and environment. |
| Support bundle | Archive | Contains a diagnostics file and sanitized log files from the past two days{% ifversion specify-period-for-support-bundle %} by default{% endif %}. |
| Extended support bundle | Archive | Contains a diagnostics file and sanitized log files from the past seven days. |
| Support bundle | Archive | Contains a diagnostics file and sanitized log files from the past two days by default. |
| Extended support bundle | Archive | Contains a diagnostics file and sanitized log files from the past eight days. |
## About log file sanitization
@ -96,7 +96,7 @@ After you submit your support request, we may ask you to share a support bundle
For more information, see "[AUTOTITLE](/admin/monitoring-activity-in-your-enterprise/reviewing-audit-logs-for-your-enterprise/about-the-audit-log-for-your-enterprise)."
Support bundles include logs from the past two days{% ifversion specify-period-for-support-bundle %} by default. You can specify an exact duration in hours or days{% endif %}. To provide logs from the past seven days, you can download an extended support bundle. For more information, see "[Creating and sharing extended support bundles](#creating-and-sharing-extended-support-bundles)."
Support bundles include logs from the past two days by default. You can specify an exact duration in hours or days. To provide logs from the past eight days, you can download an extended support bundle. For more information, see "[Creating and sharing extended support bundles](#creating-and-sharing-extended-support-bundles)."
{% tip %}
@ -157,7 +157,7 @@ You can directly upload a support bundle to our server if:
## Creating and sharing extended support bundles
Support bundles include logs from the past two days{% ifversion specify-period-for-support-bundle %} by default{% endif %}, while _extended_ support bundles include logs from the past seven days. If the events that {% data variables.contact.github_support %} is investigating occurred more than two days ago, we may ask you to share an extended support bundle. You will need SSH access to download an extended bundle - you cannot download an extended bundle from the {% data variables.enterprise.management_console %}.
Support bundles include logs from the past two days by default, while _extended_ support bundles include logs from the past eight days. If the events that {% data variables.contact.github_support %} is investigating occurred more than two days ago, we may ask you to share an extended support bundle. You will need SSH access to download an extended bundle - you cannot download an extended bundle from the {% data variables.enterprise.management_console %}.
To prevent bundles from becoming too large, bundles only contain logs that haven't been rotated and compressed. Log rotation on {% data variables.product.prodname_ghe_server %} happens at various frequencies (daily or weekly) for different log files, depending on how large we expect the logs to be.

Просмотреть файл

@ -1,4 +0,0 @@
# Reference: github/docs-content#8986
# Specify a period for log collection in a GHES support bundle
versions:
ghes: '>3.7'

Просмотреть файл

@ -0,0 +1,9 @@
{% ifversion ghes < 3.8 %}
{% note %}
**Note**: To use the `--p` / `--period` argument that appears in the following commands, your instance must be running the latest patch release. For more information, see [AUTOTITLE](/admin/release-notes).
{% endnote %}
{% endif %}

Просмотреть файл

@ -1,5 +1,5 @@
{% note %}
**Note:** If you are using a Geo-replication configuration, or {% data variables.product.prodname_enterprise %} Clustering, you should use the `ghe-cluster-support-bundle` command to retrieve the support bundle. For more information, see "[AUTOTITLE](/admin/configuration/configuring-your-enterprise/command-line-utilities#ghe-cluster-support-bundle)."
**Note:** If {% data variables.location.product_location %} is in a geo-replication configuration, or if your instance is a cluster, you should use the `ghe-cluster-support-bundle` command to retrieve the support bundle. For more information, see "[AUTOTITLE](/admin/configuration/configuring-your-enterprise/command-line-utilities#ghe-cluster-support-bundle)."
{% endnote %}