Enhance fatal errors printing of common issues seen by users (#5878)
Anis Elleuch
6 years ago
committed by
Dee Koder
parent
54cd29b51c
commit
32700fca52
@ -0,0 +1,52 @@ |
||||
/* |
||||
* Minio Cloud Storage, (C) 2018 Minio, Inc. |
||||
* |
||||
* 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. |
||||
*/ |
||||
|
||||
package logger |
||||
|
||||
import ( |
||||
"fmt" |
||||
"regexp" |
||||
|
||||
"github.com/fatih/color" |
||||
) |
||||
|
||||
// Global colors.
|
||||
var ( |
||||
colorBold = color.New(color.Bold).SprintFunc() |
||||
colorFgRed = color.New(color.FgRed).SprintfFunc() |
||||
colorBgRed = color.New(color.BgRed).SprintfFunc() |
||||
colorFgWhite = color.New(color.FgWhite).SprintfFunc() |
||||
) |
||||
|
||||
var ansiRE = regexp.MustCompile("(\x1b[^m]*m)") |
||||
|
||||
// Print ANSI Control escape
|
||||
func ansiEscape(format string, args ...interface{}) { |
||||
var Esc = "\x1b" |
||||
fmt.Printf("%s%s", Esc, fmt.Sprintf(format, args...)) |
||||
} |
||||
|
||||
func ansiMoveRight(n int) { |
||||
ansiEscape("[%dC", n) |
||||
} |
||||
|
||||
func ansiSaveAttributes() { |
||||
ansiEscape("7") |
||||
} |
||||
|
||||
func ansiRestoreAttributes() { |
||||
ansiEscape("8") |
||||
} |
||||
@ -0,0 +1,135 @@ |
||||
/* |
||||
* Minio Cloud Storage, (C) 2018 Minio, Inc. |
||||
* |
||||
* 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. |
||||
*/ |
||||
|
||||
package cmd |
||||
|
||||
import ( |
||||
"fmt" |
||||
"io" |
||||
"net" |
||||
"os" |
||||
) |
||||
|
||||
// uiErr is a structure which contains all information
|
||||
// to print a fatal error message in json or pretty mode
|
||||
// uiErr implements error so we can use it anywhere
|
||||
type uiErr struct { |
||||
msg string |
||||
detail string |
||||
action string |
||||
help string |
||||
} |
||||
|
||||
// Return the error message
|
||||
func (u uiErr) Error() string { |
||||
if u.detail == "" { |
||||
return u.msg |
||||
} |
||||
return u.detail |
||||
} |
||||
|
||||
// Replace the current error's message
|
||||
func (u uiErr) Msg(m string, args ...interface{}) uiErr { |
||||
return uiErr{ |
||||
msg: fmt.Sprintf(m, args...), |
||||
detail: u.detail, |
||||
action: u.action, |
||||
help: u.help, |
||||
} |
||||
} |
||||
|
||||
type uiErrFn func(err error) uiErr |
||||
|
||||
// Create a UI error generator, this is needed to simplify
|
||||
// the update of the detailed error message in several places
|
||||
// in Minio code
|
||||
func newUIErrFn(msg, action, help string) uiErrFn { |
||||
return func(err error) uiErr { |
||||
u := uiErr{ |
||||
msg: msg, |
||||
action: action, |
||||
help: help, |
||||
} |
||||
if err != nil { |
||||
u.detail = err.Error() |
||||
} |
||||
return u |
||||
} |
||||
} |
||||
|
||||
// errorToUIError inspects the passed error and transforms it
|
||||
// to the appropriate UI error.
|
||||
func errorToUIErr(err error) uiErr { |
||||
// If this is already a uiErr, do nothing
|
||||
if e, ok := err.(uiErr); ok { |
||||
return e |
||||
} |
||||
|
||||
// Show a generic message for known golang errors
|
||||
switch e := err.(type) { |
||||
case *net.OpError: |
||||
if e.Op == "listen" { |
||||
return uiErrPortAlreadyInUse(e).Msg("Port " + e.Addr.String() + " is already in use") |
||||
|
||||
} |
||||
case *os.PathError: |
||||
if os.IsPermission(e) { |
||||
return uiErrNoPermissionsToAccessDirFiles(e).Msg("Unsufficent permissions to access `" + e.Path + "` path") |
||||
} |
||||
} |
||||
|
||||
switch err { |
||||
case io.ErrUnexpectedEOF: |
||||
return uiErrUnexpectedDataContent(err) |
||||
default: |
||||
// Failed to identify what type of error this, return a simple UI error
|
||||
return uiErr{msg: err.Error()} |
||||
} |
||||
|
||||
} |
||||
|
||||
// fmtError() converts a fatal error message to a more understood error
|
||||
// using some colors
|
||||
func fmtError(introMsg string, err error, jsonFlag bool) string { |
||||
renderedTxt := "" |
||||
uiErr := errorToUIErr(err) |
||||
// JSON print
|
||||
if jsonFlag { |
||||
// Message text in json should be simple
|
||||
if uiErr.detail != "" { |
||||
return uiErr.msg + ": " + uiErr.detail |
||||
} |
||||
return uiErr.msg |
||||
} |
||||
// Pretty print error message
|
||||
introMsg += ": " |
||||
if uiErr.msg != "" { |
||||
introMsg += colorBold(uiErr.msg + ".") |
||||
} else { |
||||
introMsg += colorBold(err.Error() + ".") |
||||
} |
||||
renderedTxt += colorRed(introMsg) + "\n" |
||||
// Add action message
|
||||
if uiErr.action != "" { |
||||
renderedTxt += "> " + colorBgYellow(colorBlack(uiErr.action+".")) + "\n" |
||||
} |
||||
// Add help
|
||||
if uiErr.help != "" { |
||||
renderedTxt += colorBold("HELP:") + "\n" |
||||
renderedTxt += " " + uiErr.help |
||||
} |
||||
return renderedTxt |
||||
} |
||||
@ -0,0 +1,170 @@ |
||||
/* |
||||
* Minio Cloud Storage, (C) 2018 Minio, Inc. |
||||
* |
||||
* 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. |
||||
*/ |
||||
|
||||
package cmd |
||||
|
||||
var ( |
||||
uiErrInvalidConfig = newUIErrFn( |
||||
"Invalid value found in the configuration file", |
||||
"Please ensure a valid value in the configuration file, for more details refer https://docs.minio.io/docs/minio-server-configuration-guide", |
||||
"", |
||||
) |
||||
|
||||
uiErrInvalidBrowserValue = newUIErrFn( |
||||
"Invalid browser value", |
||||
"Please check the passed value", |
||||
"Browser can only accept `on` and `off` values. To disable web browser access, set this value to `off`", |
||||
) |
||||
|
||||
uiErrInvalidCacheDrivesValue = newUIErrFn( |
||||
"Invalid cache drive value", |
||||
"Please check the passed value", |
||||
"MINIO_CACHE_DRIVES: List of mounted drives or directories delimited by `;`.", |
||||
) |
||||
|
||||
uiErrInvalidCacheExcludesValue = newUIErrFn( |
||||
"Invalid cache excludes value", |
||||
"Please check the passed value", |
||||
"MINIO_CACHE_EXCLUDE: List of cache exclusion patterns delimited by `;`.", |
||||
) |
||||
|
||||
uiErrInvalidCacheExpiryValue = newUIErrFn( |
||||
"Invalid cache expiry value", |
||||
"Please check the passed value", |
||||
"MINIO_CACHE_EXPIRY: Cache expiry duration in days.", |
||||
) |
||||
|
||||
uiErrInvalidCredentials = newUIErrFn( |
||||
"Passed credentials are not suitable for use", |
||||
"Please provide correct credentials", |
||||
`Access key length should be between minimum 3 characters in length. |
||||
Secret key should not be between 8 and 40 characters.`, |
||||
) |
||||
|
||||
uiErrInvalidErasureEndpoints = newUIErrFn( |
||||
"Invalid endpoints to use in erasure mode", |
||||
"Please provide correct combinations of local/remote paths", |
||||
"For more information, please refer to the following link: https://docs.minio.io/docs/minio-erasure-code-quickstart-guide", |
||||
) |
||||
|
||||
uiErrInvalidNumberOfErasureEndpoints = newUIErrFn( |
||||
"The total number of endpoints is not suitable for erasure mode", |
||||
"Please provide an even number of endpoints greater or equal to 4", |
||||
"For more information, please refer to the following link: https://docs.minio.io/docs/minio-erasure-code-quickstart-guide", |
||||
) |
||||
|
||||
uiErrStorageClassValue = newUIErrFn( |
||||
"Invalid storage class value", |
||||
"Please check the passed value", |
||||
`MINIO_STORAGE_CLASS_STANDARD: Format "EC:<Default_Parity_Standard_Class>" (e.g. "EC:3"). This sets the number of parity disks for Minio server in Standard mode. Object are stored in Standard mode, if storage class is not defined in Put request. |
||||
MINIO_STORAGE_CLASS_RRS: Format "EC:<Default_Parity_Reduced_Redundancy_Class>" (e.g. "EC:3"). This sets the number of parity disks for Minio server in reduced redundancy mode. Objects are stored in Reduced Redundancy mode, if Put request specifies RRS storage class. |
||||
Refer to the link https://github.com/minio/minio/tree/master/docs/erasure/storage-class for more information.`,
|
||||
) |
||||
|
||||
uiErrUnexpectedBackendVersion = newUIErrFn( |
||||
"Backend version seems to be too recent", |
||||
"Please update to the latest Minio version", |
||||
"", |
||||
) |
||||
|
||||
uiErrInvalidAddressFlag = newUIErrFn( |
||||
"--address input is invalid", |
||||
"Please check --address parameter", |
||||
`--address binds a specific ADDRESS:PORT, ADDRESS can be an IP or hostname (default:':9000') |
||||
Examples: --address ':443' |
||||
--address '172.16.34.31:9000'`, |
||||
) |
||||
|
||||
uiErrInvalidFSEndpoint = newUIErrFn( |
||||
"The given endpoint is not suitable to activate standalone FS mode", |
||||
"Please check the given FS endpoint", |
||||
`FS mode requires only one writable disk path. |
||||
Example 1: |
||||
$ minio server /data/minio/`, |
||||
) |
||||
|
||||
uiErrUnableToWriteInBackend = newUIErrFn( |
||||
"Unable to write to the backend", |
||||
"Please ensure that Minio binary has write permissions to the backend", |
||||
"", |
||||
) |
||||
|
||||
uiErrUnableToReadFromBackend = newUIErrFn( |
||||
"Unable to read from the backend", |
||||
"Please ensure that Minio binary has read permission from the backend", |
||||
"", |
||||
) |
||||
|
||||
uiErrPortAlreadyInUse = newUIErrFn( |
||||
"Port is already in use", |
||||
"Please ensure no other program is using the same address/port", |
||||
"", |
||||
) |
||||
|
||||
uiErrNoPermissionsToAccessDirFiles = newUIErrFn( |
||||
"Missing permissions to access to the specified path", |
||||
"Please ensure the specified path can be accessed", |
||||
"", |
||||
) |
||||
|
||||
uiErrSSLUnexpectedError = newUIErrFn( |
||||
"Invalid TLS certificate", |
||||
"Please check the content of your certificate data", |
||||
`Only PEM (x.509) format is accepted as valid public & private certificates.`, |
||||
) |
||||
|
||||
uiErrSSLUnexpectedData = newUIErrFn( |
||||
"Something is wrong with your TLS certificate", |
||||
"Please check your certificate", |
||||
"", |
||||
) |
||||
|
||||
uiErrSSLNoPassword = newUIErrFn( |
||||
"no password was specified", |
||||
"Please set the password to this environment variable `"+TLSPrivateKeyPassword+"` so the private key can be decrypted", |
||||
"", |
||||
) |
||||
|
||||
uiErrNoCertsAndHTTPSEndpoints = newUIErrFn( |
||||
"HTTPS is specified in endpoint URLs but no TLS certificate is found on the local machine", |
||||
"Please add a certificate or switch to HTTP.", |
||||
"Refer to https://docs.minio.io/docs/how-to-secure-access-to-minio-server-with-tls for information about how to load a TLS certificate in th server.", |
||||
) |
||||
|
||||
uiErrCertsAndHTTPEndpoints = newUIErrFn( |
||||
"HTTP is specified in endpoint URLs but the server in the local machine is configured with a TLS certificate", |
||||
"Please remove the certificate in the configuration directory or switch to HTTPS", |
||||
"", |
||||
) |
||||
|
||||
uiErrSSLWrongPassword = newUIErrFn( |
||||
"Unable to decrypt the private key using the provided password", |
||||
"Please set the correct password in "+TLSPrivateKeyPassword, |
||||
"", |
||||
) |
||||
|
||||
uiErrUnexpectedDataContent = newUIErrFn( |
||||
"Unexpected data content", |
||||
"Please contact us at https://slack.minio.io", |
||||
"", |
||||
) |
||||
|
||||
uiErrUnexpectedError = newUIErrFn( |
||||
"Unexpected error", |
||||
"Please contact us at https://slack.minio.io", |
||||
"", |
||||
) |
||||
) |
||||
Loading…
Reference in new issue