codekingpro/portable-devtools
115k
1<!DOCTYPE html><html><head>
2<meta charset="utf-8">
3<title>Logging</title>
4<style>
5body {
6 background-color: #ffffff;
7 color: #24292e;
8
9 margin: 0;
10
11 line-height: 1.5;
12
13 font-family: -apple-system, BlinkMacSystemFont, "Segoe UI", Helvetica, Arial, sans-serif, "Apple Color Emoji", "Segoe UI Emoji";
14}
15#rainbar {
16 height: 10px;
17 background-image: linear-gradient(139deg, #fb8817, #ff4b01, #c12127, #e02aff);
18}
19
20a {
21 text-decoration: none;
22 color: #0366d6;
23}
24a:hover {
25 text-decoration: underline;
26}
27
28pre {
29 margin: 1em 0px;
30 padding: 1em;
31 border: solid 1px #e1e4e8;
32 border-radius: 6px;
33
34 display: block;
35 overflow: auto;
36
37 white-space: pre;
38
39 background-color: #f6f8fa;
40 color: #393a34;
41}
42code {
43 font-family: SFMono-Regular, Consolas, "Liberation Mono", Menlo, Courier, monospace;
44 font-size: 85%;
45 padding: 0.2em 0.4em;
46 background-color: #f6f8fa;
47 color: #393a34;
48}
49pre > code {
50 padding: 0;
51 background-color: inherit;
52 color: inherit;
53}
54h1, h2, h3 {
55 font-weight: 600;
56}
57
58#logobar {
59 background-color: #333333;
60 margin: 0 auto;
61 padding: 1em 4em;
62}
63#logobar .logo {
64 float: left;
65}
66#logobar .title {
67 font-weight: 600;
68 color: #dddddd;
69 float: left;
70 margin: 5px 0 0 1em;
71}
72#logobar:after {
73 content: "";
74 display: block;
75 clear: both;
76}
77
78#content {
79 margin: 0 auto;
80 padding: 0 4em;
81}
82
83#table_of_contents > h2 {
84 font-size: 1.17em;
85}
86#table_of_contents ul:first-child {
87 border: solid 1px #e1e4e8;
88 border-radius: 6px;
89 padding: 1em;
90 background-color: #f6f8fa;
91 color: #393a34;
92}
93#table_of_contents ul {
94 list-style-type: none;
95 padding-left: 1.5em;
96}
97#table_of_contents li {
98 font-size: 0.9em;
99}
100#table_of_contents li a {
101 color: #000000;
102}
103
104header.title {
105 border-bottom: solid 1px #e1e4e8;
106}
107header.title > h1 {
108 margin-bottom: 0.25em;
109}
110header.title > .description {
111 display: block;
112 margin-bottom: 0.5em;
113 line-height: 1;
114}
115
116header.title .version {
117 font-size: 0.8em;
118 color: #666666;
119}
120
121footer#edit {
122 border-top: solid 1px #e1e4e8;
123 margin: 3em 0 4em 0;
124 padding-top: 2em;
125}
126
127table {
128 width: 100%;
129 margin: 1em 0;
130 border-radius: 6px;
131 border: 1px solid #e1e4e8;
132 overflow: hidden;
133 border-collapse: separate;
134 border-spacing: 0;
135}
136
137table thead {
138 background-color: #f6f8fa;
139}
140
141table tbody {
142 background-color: #ffffff;
143}
144
145table th,
146table td {
147 padding: 0.75em;
148 text-align: left;
149 border-right: 1px solid #e1e4e8;
150 border-bottom: 1px solid #e1e4e8;
151}
152
153table th:last-child,
154table td:last-child {
155 border-right: none;
156}
157
158table tbody tr:last-child td {
159 border-bottom: none;
160}
161
162table th {
163 font-weight: 600;
164 background-color: #f6f8fa;
165}
166
167table code {
168 white-space: nowrap;
169}
170
171</style>
172</head>
173<body>
174<div id="banner">
175<div id="rainbar"></div>
176<div id="logobar">
177<svg class="logo" role="img" height="32" width="32" viewBox="0 0 700 700">
178<polygon fill="#cb0000" points="0,700 700,700 700,0 0,0"></polygon>
179<polygon fill="#ffffff" points="150,550 350,550 350,250 450,250 450,550 550,550 550,150 150,150"></polygon>
180</svg>
181<div class="title">
182npm command-line interface
183</div>
184</div>
185</div>
186
187<section id="content">
188<header class="title">
189<h1 id="----logging----11121">
190 <span>Logging</span>
191 <span class="version">@11.12.1</span>
192</h1>
193<span class="description">Why, What & How we Log</span>
194</header>
195
196<section id="table_of_contents">
197<h2 id="table-of-contents">Table of contents</h2>
198<div id="_table_of_contents"><ul><li><a href="#description">Description</a></li><li><a href="#setting-log-file-location">Setting Log File Location</a></li><li><a href="#setting-log-levels">Setting Log Levels</a></li><ul><li><a href="#loglevel"><code>loglevel</code></a></li><ul><li><a href="#aliases">Aliases</a></li></ul><li><a href="#foreground-scripts"><code>foreground-scripts</code></a></li></ul><li><a href="#timing-information">Timing Information</a></li><li><a href="#registry-response-headers">Registry Response Headers</a></li><ul><li><a href="#npm-notice"><code>npm-notice</code></a></li></ul><li><a href="#logs-and-sensitive-information">Logs and Sensitive Information</a></li><li><a href="#see-also">See also</a></li></ul></div>
199</section>
200
201<div id="_content"><h3 id="description">Description</h3>
202<p>The <code>npm</code> CLI has various mechanisms for showing different levels of information back to end-users for certain commands, configurations & environments.</p>
203<h3 id="setting-log-file-location">Setting Log File Location</h3>
204<p>All logs are written to a debug log, with the path to that file printed if the execution of a command fails.</p>
205<p>The default location of the logs directory is a directory named <code>_logs</code> inside the npm cache.
206This can be changed with the <code>logs-dir</code> config option.</p>
207<p>For example, if you wanted to write all your logs to the current working directory, you could run: <code>npm install --logs-dir=.</code>.
208This is especially helpful in debugging a specific <code>npm</code> issue as you can run a command multiple times with different config values and then diff all the log files.</p>
209<p>Log files will be removed from the <code>logs-dir</code> when the number of log files exceeds <code>logs-max</code>, with the oldest logs being deleted first.</p>
210<p>To turn off logs completely set <code>--logs-max=0</code>.</p>
211<h3 id="setting-log-levels">Setting Log Levels</h3>
212<h4 id="loglevel"><code>loglevel</code></h4>
213<p><code>loglevel</code> is a global argument/config that can be set to determine the type of information to be displayed.</p>
214<p>The default value of <code>loglevel</code> is <code>"notice"</code> but there are several levels/types of logs available, including:</p>
215<ul>
216<li><code>"silent"</code></li>
217<li><code>"error"</code></li>
218<li><code>"warn"</code></li>
219<li><code>"notice"</code></li>
220<li><code>"http"</code></li>
221<li><code>"info"</code></li>
222<li><code>"verbose"</code></li>
223<li><code>"silly"</code></li>
224</ul>
225<p>All logs pertaining to a level preceding the current setting will be shown.</p>
226<h5 id="aliases">Aliases</h5>
227<p>The log levels listed above have various corresponding aliases, including:</p>
228<ul>
229<li><code>-d</code>: <code>--loglevel info</code></li>
230<li><code>--dd</code>: <code>--loglevel verbose</code></li>
231<li><code>--verbose</code>: <code>--loglevel verbose</code></li>
232<li><code>--ddd</code>: <code>--loglevel silly</code></li>
233<li><code>-q</code>: <code>--loglevel warn</code></li>
234<li><code>--quiet</code>: <code>--loglevel warn</code></li>
235<li><code>-s</code>: <code>--loglevel silent</code></li>
236<li><code>--silent</code>: <code>--loglevel silent</code></li>
237</ul>
238<h4 id="foreground-scripts"><code>foreground-scripts</code></h4>
239<p>The <code>npm</code> CLI began hiding the output of lifecycle scripts for <code>npm install</code> as of <code>v7</code>.
240Notably, this means you will not see logs/output from packages that may be using "install scripts" to display information back to you or from your own project's scripts defined in <code>package.json</code>.
241If you'd like to change this behavior & log this output you can set <code>foreground-scripts</code> to <code>true</code>.</p>
242<h3 id="timing-information">Timing Information</h3>
243<p>The <a href="../using-npm/config#timing.html"><code>--timing</code> config</a> can be set which does a few things:</p>
244<ol>
245<li>Always shows the full path to the debug log regardless of command exit status</li>
246<li>Write timing information to a process specific timing file in the cache or <code>logs-dir</code></li>
247<li>Output timing information to the terminal</li>
248</ol>
249<p>This file contains a <code>timers</code> object where the keys are an identifier for the portion of the process being timed and the value is the number of milliseconds it took to complete.</p>
250<p>Sometimes it is helpful to get timing information without outputting anything to the terminal.
251For example, the performance might be affected by writing to the terminal.
252In this case you can use
253<code>--timing --silent</code> which will still write the timing file, but not output anything to the terminal while running.</p>
254<h3 id="registry-response-headers">Registry Response Headers</h3>
255<h4 id="npm-notice"><code>npm-notice</code></h4>
256<p>The <code>npm</code> CLI reads from & logs any <code>npm-notice</code> headers that are returned from the configured registry.
257This mechanism can be used by third-party registries to provide useful information when network-dependent requests occur.</p>
258<p>This header is not cached, and will not be logged if the request is served from the cache.</p>
259<h3 id="logs-and-sensitive-information">Logs and Sensitive Information</h3>
260<p>The <code>npm</code> CLI makes a best effort to redact the following from terminal output and log files:</p>
261<ul>
262<li>Passwords inside basic auth URLs</li>
263<li>npm tokens</li>
264</ul>
265<p>However, this behavior should not be relied on to keep all possible sensitive information redacted.
266If you are concerned about secrets in your log file or terminal output, you can use <code>--loglevel=silent</code> and <code>--logs-max=0</code> to ensure no logs are written to your terminal or filesystem.</p>
267<h3 id="see-also">See also</h3>
268<ul>
269<li><a href="../using-npm/config.html">config</a></li>
270</ul></div>
271
272<footer id="edit">
273<a href="https://github.com/npm/cli/edit/latest/docs/lib/content/using-npm/logging.md">
274<svg role="img" viewBox="0 0 16 16" width="16" height="16" fill="currentcolor" style="vertical-align: text-bottom; margin-right: 0.3em;">
275<path fill-rule="evenodd" d="M11.013 1.427a1.75 1.75 0 012.474 0l1.086 1.086a1.75 1.75 0 010 2.474l-8.61 8.61c-.21.21-.47.364-.756.445l-3.251.93a.75.75 0 01-.927-.928l.929-3.25a1.75 1.75 0 01.445-.758l8.61-8.61zm1.414 1.06a.25.25 0 00-.354 0L10.811 3.75l1.439 1.44 1.263-1.263a.25.25 0 000-.354l-1.086-1.086zM11.189 6.25L9.75 4.81l-6.286 6.287a.25.25 0 00-.064.108l-.558 1.953 1.953-.558a.249.249 0 00.108-.064l6.286-6.286z"></path>
276</svg>
277Edit this page on GitHub
278</a>
279</footer>
280</section>
281
282
283
284</body></html>