Skip to content
Projects
Groups
Snippets
Help
Loading...
Help
Support
Keyboard shortcuts
?
Submit feedback
Contribute to GitLab
Sign in / Register
Toggle navigation
G
gitlab-ce
Project overview
Project overview
Details
Activity
Releases
Repository
Repository
Files
Commits
Branches
Tags
Contributors
Graph
Compare
Issues
0
Issues
0
List
Boards
Labels
Milestones
Merge Requests
1
Merge Requests
1
Analytics
Analytics
Repository
Value Stream
Wiki
Wiki
Snippets
Snippets
Members
Members
Collapse sidebar
Close sidebar
Activity
Graph
Create a new issue
Commits
Issue Boards
Open sidebar
nexedi
gitlab-ce
Commits
71d073fc
Commit
71d073fc
authored
Jun 19, 2020
by
Daniel Paul Searles
Committed by
Russell Dickenson
Jun 19, 2020
Browse files
Options
Browse Files
Download
Email Patches
Plain Diff
Add docs for common's logutil within secure integration docs
parent
bf4c17b9
Changes
1
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
with
28 additions
and
0 deletions
+28
-0
doc/development/integrations/secure.md
doc/development/integrations/secure.md
+28
-0
No files found.
doc/development/integrations/secure.md
View file @
71d073fc
...
@@ -232,6 +232,34 @@ to colorize the messages they write to the Unix standard output and standard err
...
@@ -232,6 +232,34 @@ to colorize the messages they write to the Unix standard output and standard err
We recommend using red to report errors, yellow for warnings, and green for notices.
We recommend using red to report errors, yellow for warnings, and green for notices.
Also, we recommend prefixing error messages with
`[ERRO]`
, warnings with
`[WARN]`
, and notices with
`[INFO]`
.
Also, we recommend prefixing error messages with
`[ERRO]`
, warnings with
`[WARN]`
, and notices with
`[INFO]`
.
#### Logging level
The scanner should filter out a log message if its log level is lower than the
one set in the
`SECURE_LOG_LEVEL`
variable. For instance,
`info`
and
`warn`
messages should be skipped when
`SECURE_LOG_LEVEL`
is set to
`error`
. Accepted
values are as follows, listed from highest to lowest:
-
`panic`
-
`fatal`
-
`error`
-
`warn`
-
`info`
-
`debug`
-
`trace`
It is recommended to use the
`debug`
and
`trace`
levels for verbose logging
that could be useful when debugging. The default value for
`SECURE_LOG_LEVEL`
should be set to
`info`
.
#### common logutil package
If you are using
[
go
](
https://golang.org/
)
and
[
common
](
https://gitlab.com/gitlab-org/security-products/analyzers/common
)
,
then it is suggested that you use
[
logrus
](
https://github.com/Sirupsen/logrus
)
and
[
common's logutil package
](
https://gitlab.com/gitlab-org/security-products/analyzers/common/-/tree/master/logutil
)
to configure the formatter for
[
logrus
](
https://github.com/Sirupsen/logrus
)
.
See the
[
logutil README.md
](
https://gitlab.com/gitlab-org/security-products/analyzers/common/-/tree/master/logutil/README.md
)
## Report
## Report
The report is a JSON document that combines vulnerabilities with possible remediations.
The report is a JSON document that combines vulnerabilities with possible remediations.
...
...
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment