Page MenuHomestyx hydra
Files F228772

No OneTemporary
Actions

View Options

diff --git a/src/docs/developer/darkconsole.diviner b/src/docs/developer/darkconsole.diviner
index 7f15f7fd98..3a15c0eb02 100644
--- a/src/docs/developer/darkconsole.diviner
+++ b/src/docs/developer/darkconsole.diviner
@@ -1,63 +1,60 @@
@title Using DarkConsole
@group developer
Enabling and using the built-in debugging console.
= Overview =
DarkConsole is a debugging console built into Phabricator which exposes
configuration, performance and error information. It can help you detect,
understand and resolve bugs and performance problems in Phabricator
applications.
DarkConsole was originally implemented as part of the Facebook Lite site;
its name is a bit of play on that (and a reference to the dark color palette
its design uses).
-= Enabling DarkConsole =
+= Warning =
Because DarkConsole exposes some configuration and debugging information, it is
disabled by default (and **you should not enable it in production**). It has
-some simple safeguards to prevent leaking credential information but enabling it
-in production may compromise the integrity of an install.
+some simple safeguards to prevent leaking credential information, but enabling
+it in production may compromise the integrity of an install.
+
+= Enabling DarkConsole =
-You enable DarkConsole in your configuration, by setting ##darkconsole.enabled##
-to ##true##, and then clicking the "Enable DarkConsole" link in the page footer.
+You enable DarkConsole in your configuration, by setting `darkconsole.enabled`
+to `true`, and then turning it on in `Settings` -> `Display Preferences`.
Once DarkConsole is enabled, you can show or hide it by pressing ##`## on your
keyboard.
-Since the "Enable DarkConsole" link is not available to logged-out users (and
-stored as a per-user preference), you can also set ##darkconsole.always-on## if
-you need to access DarkConsole on logged-out pages.
+Since the setting is not available to logged-out users, you can also set
+`darkconsole.always-on` if you need to access DarkConsole on logged-out pages.
DarkConsole has a number of tabs, each of which is powered by a "plugin". You
can use them to access different debugging and performance features.
= Plugin: Error Log =
The "Error Log" plugin shows errors that occurred while generating the page,
similar to the httpd ##error.log##. You can send information to the error log
explicitly with the @{function@libphutil:phlog} function.
If errors occurred, a red dot will appear on the plugin tab.
= Plugin: Request =
The "Request" plugin shows information about the HTTP request the server
received, and the server itself.
= Plugin: Services =
The "Services" plugin lists calls a page made to external services, like
MySQL and the command line.
= Plugin: XHProf =
The "XHProf" plugin gives you access to the XHProf profiler. To use it, you need
to install the corresponding PHP plugin -- see instructions in the
@{article:Installation Guide}. Once it is installed, you can use XHProf to
profile the runtime performance of a page.
-
-= Plugin: Config =
-
-The "Config" plugin shows active Phabricator configuration values.

File Metadata

Mime Type
text/x-diff
Expires
Thu, Jul 24, 9:15 AM (1 d, 8 h)
Storage Engine
blob
Storage Format
Raw Data
Storage Handle
182661
Default Alt Text
(3 KB)

Event Timeline

styx copyright 2020 sirocyl / ellie (kymkdd) / ncommander / styx contributors
Use of other names and brands is not intended to reflect a claim of, or right to, use the name or brand.
styx is an operating system using the Linux kernel and components, and "styx Linux" as a phrase does not reflect the inclusion of the Linux brand or trademark in the styx project.
Linux® is the registered trademark of Linus Torvalds in the U.S. and other countries.
Terms and Conditions (TODO: fix this!)