mirror of
https://github.com/minio/docs.git
synced 2025-07-31 18:04:52 +03:00
Adds Call Home information to the troubleshooting doc (#801)
Closes #751
This commit is contained in:
Daryl White
GitHub
@ -18,7 +18,7 @@ and destination buckets.
|
||||
The deployment where you configure the bucket replication rule acts as the "source" while the configured remote deployment acts as the "target".
|
||||
MinIO applies rules as part of object write operations (e.g. ``PUT``) and automatically synchronizes new objects *and* object mutations, such as new object versions or changes to object metadata.
|
||||
|
||||
MinIO server-side bucket replication only supports MinIO clusters for the remote replication target.
|
||||
MinIO server-side bucket replication only supports a MinIO cluster on an identical release for the remote replication target.
|
||||
|
||||
Client-side Bucket Replication
|
||||
Use the command process to synchronize objects between buckets within the same S3-compatible cluster *or* between two independent S3-compatible clusters.
|
||||
|
||||
@ -135,6 +135,8 @@ Deployment Health
|
||||
The deployment's details include a summary of the deployment's configuration and the number of checks run and failed.
|
||||
You can select :guilabel:`Upload` to add diagnostic health data obtained from the :mc:`mc support diag` command or the MinIO Console's :guilabel:`Support > Health` page.
|
||||
|
||||
You can also use the :ref:`Call Home <minio-troubleshooting-call-home>` functionality to automatically run and upload a diagnostic health report.
|
||||
|
||||
If you need support from MinIO Engineering, you can create a :guilabel:`New Issue` for the deployment.
|
||||
|
||||
.. image:: /images/subnet/SUBNET-deployment-health-summary.png
|
||||
@ -156,6 +158,78 @@ You can scroll vertically through the output for the selected check.
|
||||
:alt: MinIO SUBNET's health report for a deployment showing a failed Health Report with details expanded
|
||||
:align: center
|
||||
|
||||
Logs
|
||||
----
|
||||
|
||||
Use :mc:`mc admin logs` command to display logs from the command line.
|
||||
The command supports type and quantity filters for further limiting logs output.
|
||||
|
||||
Optionally, use :ref:`Call Home <minio-troubleshooting-call-home>` to start automatically uploading real time error logs to SUBNET for analysis.
|
||||
|
||||
.. _minio-troubleshooting-call-home:
|
||||
|
||||
Call Home
|
||||
---------
|
||||
|
||||
.. versionadded:: ``minio`` RELEASE.2022-11-17T23-20-09Z and ``mc`` RELEASE.2022-12-02T23-48-47Z
|
||||
|
||||
MinIO's opt-in Call Home service automates the collection and uploading of diagnostic data or error logs to SUBNET.
|
||||
Call Home requires the cluster have both an active SUBNET registration and reliable access to the internet.
|
||||
|
||||
.. important::
|
||||
|
||||
Call Home does not work for airgapped deployments.
|
||||
|
||||
When enabled, Call Home can upload one or both of:
|
||||
|
||||
- error logs in real time
|
||||
- a new diagnostic report every 24 hours
|
||||
|
||||
Once uploaded, you can view the diagnostic report results or logs through SUBNET as described above, but without the need to manually upload the data yourself.
|
||||
Making these records automatically available in SUBNET simplifies visibility into cluster health and functionality.
|
||||
If you submit an issue for support help from the MinIO engineers, the engineers have immediate access to the errors and/or logs you have uploaded.
|
||||
|
||||
Diagnostic Report
|
||||
+++++++++++++++++
|
||||
|
||||
The diagnostic report upload happens every 24 hours from the time you enable Call Home.
|
||||
If you restart all nodes on the deployment after enabling Call Home, the upload happens every 24 hours from the deployment restart.
|
||||
|
||||
.. important::
|
||||
|
||||
The diagnostic report does **not** collect or upload any personally identifiable information.
|
||||
|
||||
The report includes information such as:
|
||||
|
||||
- System settings, services, and configurations that might impact performance
|
||||
- TLS certificate status, validity, expiration, and algorithm type information
|
||||
- CPU core count and information
|
||||
- Drive count, status, size, and available space
|
||||
- Cluster size server count
|
||||
- File system type
|
||||
- Memory size and type
|
||||
- OS symmetry and Linux kernel version
|
||||
- Internode latency
|
||||
- NTP synchronization
|
||||
- Available resources
|
||||
- MinIO version
|
||||
|
||||
Error Logs
|
||||
++++++++++
|
||||
|
||||
When the MinIO Server encounters an error, it writes it to a log.
|
||||
These logs can upload in real time to SUBNET, where you or MinIO engineers can view the errors.
|
||||
|
||||
Enabling or Disabling Call Home
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
Call Home is **disabled** by default.
|
||||
You can :mc-cmd:`~mc support callhome enable` and :mc-cmd:`~mc support callhome disable` Call Home functionality at any time using the MinIO Client's :mc-cmd:`mc support callhome` commands.
|
||||
The command and its subcommands allow you to enable Call Home uploads for only the diagnostics, only the error logs, or both.
|
||||
Refer to the documentation on the commands for more details.
|
||||
|
||||
Use :mc-cmd:`mc support callhome status` to check the status of an upload.
|
||||
|
||||
Uploading Data to SUBNET
|
||||
------------------------
|
||||
|
||||
@ -175,16 +249,6 @@ Encrypting Data
|
||||
Data from the Inspect tool in :ref:`Console <minio-console>` or the :mc:`mc support inspect` command can be encrypted.
|
||||
For more details about encrypting or decrypting such files, see :ref:`Encrypting Files <minio-support-encryption>`.
|
||||
|
||||
Logs
|
||||
----
|
||||
|
||||
Use :mc-cmd:`mc support callhome enable` to start automatically uploading deployment logs to SUBNET for analysis.
|
||||
Use :mc-cmd:`mc support callhome status` to check the status of log upload.
|
||||
You can disable upload at any time using :mc-cmd:`mc support callhome disable`.
|
||||
|
||||
Use :mc:`mc admin logs` command to display logs from the command line.
|
||||
The command supports type and quantity filters for further limiting logs output.
|
||||
|
||||
Upgrades and Version Support
|
||||
----------------------------
|
||||
|
||||
|
||||
@ -29,6 +29,8 @@ The :mc:`mc replicate add` command creates a new :ref:`server-side replication
|
||||
|
||||
.. end-mc-replicate-add-desc
|
||||
|
||||
The remote bucket **must** be on a MinIO deployment running the same version of MinIO as the local deployment.
|
||||
|
||||
.. note::
|
||||
|
||||
Where :mc:`mc mirror` only synchronizes the current version of an object, ``mc replicate`` synchronizes all versions, version information, and metadata for the objects.
|
||||
@ -36,10 +38,6 @@ The :mc:`mc replicate add` command creates a new :ref:`server-side replication
|
||||
The MinIO deployment automatically begins synchronizing new objects to the remote MinIO deployment after creating the rule.
|
||||
You can optionally configure synchronization of existing objects, delete operations, and fully-deleted objects.
|
||||
|
||||
This command *requires* first configuring the remote bucket target using the
|
||||
:mc-cmd:`mc admin bucket remote add` command. You must specify the resulting
|
||||
remote ARN as part of running :mc:`mc replicate add`.
|
||||
|
||||
.. tab-set::
|
||||
|
||||
.. tab-item:: EXAMPLE
|
||||
|
||||
Reference in New Issue
Block a user