snowchive-meta/data/category-throttling/category-throttling.md
2026-11-19 04:39:11 +02:00

3.3 KiB

SECRET//COMINT//REL TO USA, AUS, CAN, GBR, NZL

How to configure category throttling in XKEYSCORE

Category throttling is performed by the selected output plugin, in the xks.config you need to make sure that you are using this plugin to perform forwarding. You will also need to have throttle=yes in the config for the plugin.

Ex:

plugin[selected_output] = enable=yes, config_file="throttle=yes
directory=/export/data/xkeyscore/outputs/mailorder_working
add_d706=true pass_fragments=true max_age=900 max_size=5000000"

If this was not already set, in order for the changes to take effect you will need to then perform the following commands:

xks setup plugins
xks proc saferestart

At this point category throttling is now enabled with the default values of 1GB and 1000000000000 sessions. Once either of these limits is reached XKEYSCORE will continue to process data but will no longer forward session that hit on that category. By navigating to the category throttle page you will be able to see the current status of the categories that have been throttled. A category will not appear on this page until it has hit once that day. In the following example the site default was changed to 5MB and 500 sessions:

SECRET
XKEYSCORE Welcome oper! Log Out
Home Admin Users Workflow Central Search Results Statistics My Account Help
Navigation Menu
Admin
  Processing
    Computer Resources
    Input Directories
    Plugin Configurations
    Category Throttle
    Age Off Settings
  Databases
    Search DBs
    DB Registration
  Casenotation Blacklist
New Fist | Change Site Default | Site Defaults --> Category Quota:5 MB, Sessions Quota:500
SECRET

After session start to hit you will see the status displayed on this page:

Derived From: NSA/CSSM 1-52 Dated: 20070108 Declassify On: 20350401 SECRET//COMINT//REL TO USA, AUS, CAN, GBR, NZL

SECRET//COMINT//REL TO USA, AUS, CAN, GBR, NZL

SECRET
XKEYSCORE Welcome oper! Log Out
Home Admin Users Workflow Central Search Results Statistics My Account Help
Navigation Menu
Admin
  Processing
    Computer Resources
    Input Directories
    Plugin Configurations
    Category Throttle
    Age Off Settings
  Databases
    Search DBs
    DB Registration
  Casenotation Blacklist
New Fist | Change Site Default | Site Defaults --> Category Quota:5 MB, Sessions Quota:500
TEST
Add Category Throttle Change Fist Default Reset Fist Default

Category | Daily Category Quota | Quota Remaining | Quota Over | Daily Session Quota | Sessions Remaining | Sessions Over
| -- | --- | ------- | -------- | --- | --- | ---- |
| 4 | 5 MB | 0 bytes | 342.8 KB | 500 | 298 | 0
| 2 | 5 MB | 5 MB    | 0 bytes  | 500 | 500 | 0
| 1 | 5 MB | 0 bytes | 26.5 MB  | 500 | 0   | 2025
SECRET

In the example above categories 1 and 4 and currently being throttled, category 1 has reached both the session count and MB limit, while category 4 has only reached the MB limit. Without category throttling category 4 would have forwarded 342.8KB.

You can also check the status of the throttle from the command line using:

mysqls quota_status_current : show quota_limits forwarding status for all categories mysqls quota_status_yesterday : show quota_limits forwarding status for previous day mysqls quota_throttled_current : shows top 20 categories for current day. (negative remaining indicates cat was throttled)

SECRET//COMINT//REL TO USA, AUS, CAN, GBR, NZL