the browser-facing portion of osu!
at master 212 lines 8.1 kB view raw
1<?php 2 3return [ 4 5 /* 6 |-------------------------------------------------------------------------- 7 | Enable Clockwork 8 |-------------------------------------------------------------------------- 9 | 10 | You can explicitly enable or disable Clockwork here. When enabled, special 11 | headers for communication with the Clockwork Chrome extension will be 12 | included in your application responses and requests data will be available 13 | at /__clockwork url. 14 | When set to null, Clockwork behavior is controlled by app.debug setting. 15 | Default: null 16 | 17 */ 18 19 'enable' => env('CLOCKWORK_ENABLE', null), 20 21 /* 22 |-------------------------------------------------------------------------- 23 | Enable web UI 24 |-------------------------------------------------------------------------- 25 | 26 | Enable or disable the Clockwork web UI available at http://your.app/__clockwork. 27 | You can also set whether to use the dark theme by default. 28 | Default: true 29 | 30 */ 31 32 'web' => env('CLOCKWORK_WEB', true), 33 34 'web_dark_theme' => env('CLOCKWORK_WEB_DARK_THEME', false), 35 36 /* 37 |-------------------------------------------------------------------------- 38 | Enable data collection, when Clockwork is disabled 39 |-------------------------------------------------------------------------- 40 | 41 | This setting controls, whether data about application requests will be 42 | recorded even when Clockwork is disabled (useful for later analysis). 43 | Default: false 44 | 45 */ 46 47 'collect_data_always' => env('CLOCKWORK_COLLECT_DATA_ALWAYS', false), 48 49 /* 50 |-------------------------------------------------------------------------- 51 | Metadata storage 52 |-------------------------------------------------------------------------- 53 | 54 | You can configure how are the metadata collected by Clockwork stored. 55 | Valid options are: files or sql. 56 | Files storage stores the metadata in one-per-request files in a specified 57 | directory. 58 | Sql storage stores the metadata as rows in a sql database. You can specify 59 | the database by name if defined in database.php or by path to Sqlite 60 | database. Database table will be automatically created. 61 | Sql storage requires PDO. 62 | 63 */ 64 65 'storage' => env('CLOCKWORK_STORAGE', 'sql'), 66 67 'storage_files_path' => env('CLOCKWORK_STORAGE_FILES_PATH', storage_path('clockwork')), 68 69 'storage_sql_database' => env('CLOCKWORK_STORAGE_SQL_DATABASE', storage_path('clockwork.sqlite')), 70 'storage_sql_table' => env('CLOCKWORK_STORAGE_SQL_TABLE', 'clockwork'), 71 72 /* 73 |-------------------------------------------------------------------------- 74 | Metadata expiration 75 |-------------------------------------------------------------------------- 76 | 77 | Maximum lifetime of the metadata in minutes, metadata for older requests 78 | will automatically be deleted when storing new requests. 79 | When set to false, metadata will never be deleted. 80 | Default: 1 week 81 | 82 */ 83 84 'storage_expiration' => env('CLOCKWORK_STORAGE_EXPIRATION', 60 * 24 * 7), 85 86 /* 87 |-------------------------------------------------------------------------- 88 | Authentication 89 |-------------------------------------------------------------------------- 90 | 91 | Clockwork can be configured to require authentication before allowing 92 / access to the collected data. This is recommended when the application 93 / is publicly accessible, as the metadata might contain sensitive information. 94 / Setting to "true" enables authentication with a single password set below, 95 / "false" disables authentication. 96 / You can also pass a class name of a custom authentication implementation. 97 / Default: false 98 | 99 */ 100 101 'authentication' => env('CLOCKWORK_AUTHENTICATION', false), 102 103 'authentication_password' => env('CLOCKWORK_AUTHENTICATION_PASSWORD', 'VerySecretPassword'), 104 105 /* 106 |-------------------------------------------------------------------------- 107 | Filter collected data 108 |-------------------------------------------------------------------------- 109 | 110 | You can filter collected data by specifying what you don't want to collect 111 | here. 112 | 113 */ 114 115 'filter' => [ 116 'cacheQueries', // collecting cache queries in cache-heavy might have a negative performance impact and use a lot of disk space 117 'routes', // collecting routes data on every request might use a lot of disk space 118 'viewsData', // collecting views data, including all variables passed to the view on every request might use a lot of disk space 119 ], 120 121 /* 122 |-------------------------------------------------------------------------- 123 | Disable data collection for certain URIs 124 |-------------------------------------------------------------------------- 125 | 126 | You can disable data collection for specific URIs by adding matching 127 | regular expressions here. 128 | 129 */ 130 131 'filter_uris' => [ 132 '/__clockwork/.*', // disable collecting data for clockwork-web assets 133 '/horizon/.*', // disable collecting data for Laravel Horizon requests 134 ], 135 136 /* 137 |-------------------------------------------------------------------------- 138 | Enable collecting of stack traces 139 |-------------------------------------------------------------------------- 140 | 141 | This setting controls, whether log messages and certain data sources, like 142 / the database or cache data sources, should collect stack traces. 143 / You might want to disable this if you are collecting 100s of queries or 144 / log messages, as the stack traces can considerably increase the metadata size. 145 / You can force collecting of stack trace for a single log call by passing 146 / [ 'trace' => true ] as $context. 147 | Default: true 148 | 149 */ 150 151 'collect_stack_traces' => env('CLOCKWORK_COLLECT_STACK_TRACES', true), 152 153 /* 154 |-------------------------------------------------------------------------- 155 | Ignored events 156 |-------------------------------------------------------------------------- 157 | 158 | Array of event names that will be ignored when collecting data for the "events" tab. 159 | By default all framework-specific events are also ignored, set to false to log 160 | all possible fired events. 161 | 162 */ 163 164 'ignored_events' => [ 165 ], 166 167 /* 168 |-------------------------------------------------------------------------- 169 | Register helpers 170 |-------------------------------------------------------------------------- 171 | 172 | This setting controls whether the "clock" helper function will be registered. You can use the "clock" function to 173 | quickly log something to Clockwork or access the Clockwork instance. 174 | 175 */ 176 177 'register_helpers' => env('CLOCKWORK_REGISTER_HELPERS', true), 178 179 /* 180 |-------------------------------------------------------------------------- 181 | Send Headers for AJAX request 182 |-------------------------------------------------------------------------- 183 | 184 | When trying to collect data the AJAX method can sometimes fail if it is 185 | missing required headers. For example, an API might require a version 186 | number using Accept headers to route the HTTP request to the correct 187 | codebase. 188 | 189 */ 190 191 'headers' => [ 192 // 'Accept' => 'application/vnd.com.whatever.v1+json', 193 ], 194 195 /* 196 |-------------------------------------------------------------------------- 197 | Server-Timing 198 |-------------------------------------------------------------------------- 199 | 200 | Clockwork supports the W3C Server Timing specification, which allows for 201 / collecting a simple performance metrics in a cross-browser way. Eg. in 202 / Chrome, your app, database and timeline event timings will be shown 203 / in the Dev Tools network tab. 204 / This setting specifies the max number of timeline events that will be sent. 205 | When set to false, Server-Timing headers will not be set. 206 | Default: 10 207 | 208 */ 209 210 'server_timing' => env('CLOCKWORK_SERVER_TIMING', 10), 211 212];