Documentation

Help & guides
18 topics · Reviewed 21 Sep 2026

01 / Understand

Platform essentials

ClearSOC is an AI-assisted security operations platform for Akamai WAF telemetry. It brings traffic exploration, entity analysis, response decisions, and historical reporting into one workspace.

Available today

Akamai log ingestion, scenario detection, IP / ASN / TLS fingerprint analysis, Gemini-assisted decisions and reports, and configurable Akamai Client Lists integration.

Provider expansion

Cloudflare and a provider-neutral traffic model are planned. The current analysis pipeline and queries use Akamai telemetry; do not assume another provider is connected.

The dashboard presents stored observations and job results. Its animations and status labels do not establish that an analysis is running right now. Check timestamps and the selected time window before interpreting activity.

Start with the question. Use the command center for posture, Analysis for traffic, AI Decisions for entity state, and Security Analysis for a historical briefing.
02 / Operate

Start a shift

  1. Read the recorded posture. Open the command center. Note the mode, last scenario, and last AI decision. Refresh if the page has been open for a while.
  2. Set the scope. In Analysis, choose the hostname and time window. Keep those values with your investigation notes.
  3. Review the queue. Open AI Decisions and filter by entity type, state, severity, confidence, or hostname.
  4. Inspect evidence. Open an entity’s investigation. Compare its activity with the scenario and AI rationale before choosing an action.
  5. Verify the outcome. Separate the local decision from the provider update and activation. Carry unresolved enforcement or evidence gaps into the handoff.

Unexpectedly quiet workspace? Check telemetry and job recency before concluding that the environment is quiet.

03 / Understand

The three analysis layers

The layers serve different purposes. First-level analysis prepares entity evidence; it is not a separate language-model opinion.

01 / Detect conditions

Attack scenarios

Count requests matching configured traffic, action, hostname, and path conditions. A count threshold and severity shape the monitoring mode.

02 / Prepare evidence

First-level analysis

Aggregate recent traffic by IP, ASN, and TLS fingerprint. Apply configured minimum request counts and, where enabled, sampling before staging candidates.

03 / Recommend action

AI analysis

Send staged entities, watchlist context, and scenario context to Gemini. Validate the response and apply policy before recording the final action.

Jobs run on schedules. Mode gating, run limits, feature switches, and retry timing can prevent an AI call. The diagram describes the logical flow, not a guarantee that every request reaches all three layers.

Where the data comes from

Akamai logs arrive in the configured S3-compatible storage. The ingestor loads ClickHouse; the dashboard and analysis jobs primarily read akamai_logs_min. Entity state, scenario events, and AI task records provide additional context.

The scheduler runs ingestion, scenario evaluation, entity staging, AI mitigation, and reporting jobs. Historical summaries are a separate reporting workflow, not a fourth enforcement layer.

04 / Operate

Read the command center

The dashboard combines an intelligence core, operational briefing, three analysis links, a traffic pulse, and a chronological activity timeline.

Interpreting monitoring mode
Recorded modeWhat to do
BaselineNo active scenario escalation is recorded. Check recency; this is not a clean bill of health for every entity.
ElevatedReview the matching conditions and affected traffic. Whether heavy AI runs depends on the analysis mode setting.
AttackPrioritize the triggering conditions and related entities. The mode describes scenario posture, not confirmed compromise.
UnavailableMonitoring state could not be established. Check data and job health before relying on the posture view.

Traffic metrics carry a time window and hostname scope. The current watchlist is labeled as all-host state. The timeline contains recent recorded events; it is not a streaming connection. Use Refresh to retrieve a new snapshot.

05 / Investigate

Explore traffic without losing context

Use Analysis to compare traffic patterns, inspect paths and sources, and narrow a hypothesis. Begin with a hostname and time window, then examine request volumes alongside WAF signals.

  • A flag is evidence to examine. WAF alerts and denies are provider signals, not ground-truth maliciousness labels.
  • Alert and deny counts can overlap. One request may contain both kinds of signals. Do not automatically add them to estimate unique requests.
  • Distinct rules are not request counts. An entity’s unique rule list describes variety; request totals describe volume.
  • Rate needs a window. A large daily total alone does not establish a short burst.

Geography, ASN, and a TLS fingerprint provide context. They do not uniquely identify a person or prove intent. Keep the entity’s own paths, counts, rule matches, and timing central to the review.

06 / Respond

Separate decisions from enforcement

AI Decisions is the review queue. Model recommendations can be changed by policy before the final local state is recorded.

Supported AI actions
ActionMeaning
blockRecommend or record a block. External enforcement depends on the configured provider integration and its result.
keep_in_watchlistKeep the entity under review when evidence or policy does not justify automatic blocking.
remove_from_watchlistRemove the local review state. This does not establish that the entity was always benign.

How automated recommendations are constrained

Policy considers advisory versus enforce mode, confidence thresholds, non-IP blocking permissions, scenario requirements, and review requirements for ASN or TLS actions. Inspect the model action, final action, and policy explanation when a recommendation was downgraded.

Confidence is a model estimate. A score of 99% is not a measured 99% probability of correctness. Validate the supporting evidence and possible benign explanations.

What provider status establishes

Akamai integration appends entries to configured Client Lists and can request activation. appended or already_present describes list membership. An activation response alone does not verify completed propagation or that a policy is using that list. Confirm the intended network and provider-side result.

disabled means external blocking was not enabled; failed means the provider operation failed. A local blocklist row can still exist in either case. Conversely, changing an entity to watchlist or removing it locally does not automatically remove an existing Akamai Client List entry in the current implementation.

07 / Investigate

Investigate an entity

Open an entity from the decisions queue to reach its Investigation Workspace. Review its current state, AI rationale, traffic context, and related activity together.

  1. Confirm the entity type: an IP, an ASN, or a TLS fingerprint.
  2. Check last-seen time and the period represented by the evidence.
  3. Compare flagged requests with total requests; inspect paths and matched rules.
  4. Look for corroborating evidence and plausible legitimate activity.
  5. Choose the narrowest justified action, then verify local and external outcomes separately.

IP

An IP can still represent a proxy, NAT, or multiple clients. Review observed behavior rather than relying on reputation alone.

ASN & TLS fingerprint

Both can group unrelated clients. A TLS fingerprint describes client handshake characteristics; it is not a TLS certificate or a unique device identity.

Manual actions require the Trigger actions permission. They are analyst overrides, not a new automatic AI policy evaluation. Review any provider changes independently, including when automated mitigation is advisory.

08 / Report

Read a security briefing

Security Analysis provides the redesigned report reader. Reports remains available as the existing reporting workspace.

  • Choose Daily, Weekly, or Monthly, then select an entry in the report archive.
  • Check both the covered time range and generated timestamp. Reports are historical, not live incident status.
  • Read the narrative alongside period facts, scenario triggers, and security events.
  • Use In this report on desktop to jump to narrative headings and supporting evidence.
  • Use Download summary to save the narrative as Markdown. This download is not an export of all telemetry or side-panel evidence.

The reader currently offers the latest ten summaries per cadence. Supporting event lists are limited previews. When totals and narrative appear inconsistent, compare the covered dates and source records; some metrics can fall back to values parsed from the generated report when telemetry values are unavailable or zero.

Unavailable or N/A means a value is missing. Do not treat it as zero. Narrative text remains readable if formatting scripts are unavailable.

09 / Investigate

Ask ClearSOC a precise question

The AI Assistant plans queries using approved read-only tools for traffic, paths, attackers, entity profiles, blocklist state, and comparisons. It does not execute arbitrary SQL or perform mitigation actions through chat.

Useful starting questions

  • “Summarize WAF activity over the last 6 hours for host app.example.com.”
  • “Show recent security events for IP 192.0.2.18 over the last 24 hours.”
  • “Which paths have the most flagged requests in the last 7 days?”
  • “Compare the last 24 hours with the previous 24 hours.”

These are examples, not requests sent from this guide.

Include the hostname, entity, and time window in the question. Do not assume filters selected on another page carry into chat. Review the answer’s time scope and compare important claims with the underlying investigation.

10 / Configure

Understand scenarios and AI gating

Attack Scenarios defines traffic type/subtype, action scope, optional hostname and paths, count window, threshold, severity, and timing settings.

The current evaluator uses matching request count ≥ configured threshold. P1 maps to attack mode; P2 and P3 map to elevated mode. Names such as “ratio spike” do not mean a statistical baseline or ratio comparison is being calculated.

Heavy AI eligibility when the scenario engine is enabled
SettingEligible monitoring modes
alwaysBaseline, elevated, and attack
elevated_or_attack_onlyElevated and attack
scenario_triggered_onlyAttack only

Eligibility is not a guarantee of execution: feature switches, hourly limits, retry timing, and candidate availability also apply. First-level staging can be skipped in baseline mode when heavy AI is gated.

Cooldown and timing

Scenario cooldown suppresses repeated trigger events. Monitoring-mode cooldown can hold a recorded mode after a trigger. Neither proves that an attack is still active; compare the last trigger with current traffic.

Use actual event and AI task timestamps to verify behavior after changing scenario settings. A scenario’s label or trigger flag alone does not prove a model call took place.

11 / Configure

Change configuration deliberately

Admin controls integrations, AI models, mitigation policy, reporting, and job settings. Prompts contains workflow instructions; Advanced exposes additional operational controls.

When a setting takes effect
ScopeExpected behavior
ImmediateRead by the relevant dashboard operation on a subsequent request.
Next job runRead when the worker process next starts; an already running job retains its existing context.
Restart requiredScheduler cadence and enablement settings are loaded at scheduler startup. Save the setting, then arrange a targeted restart.

Use the scope shown beside the setting. Record what changed and compare the next applicable run with the intended result. Test prompt changes against representative benign and malicious examples before depending on them for automated decisions.

Provider credentials are configured through supported integration settings or the deployment environment. Keep credentials out of reports, chat prompts, and incident notes.

12 / Configure

Route notifications and check delivery

Notifications supports Slack and Discord webhooks. Destinations can select scenario, entity, approval-request, and summary events, with filters and suppression controls.

  1. Confirm the destination is enabled and the event type is selected.
  2. Check severity, confidence, and other routing filters.
  3. Check suppression or deduplication before treating a missing message as a delivery failure.
  4. Review delivery records. Use the test action only when you intend to send a message to the configured destination.

A delivered notification proves delivery to the channel, not completed enforcement. An approval-request event should be followed through the review workflow; it is not proof an action was approved.

13 / Operate

Measure health and effectiveness separately

AI Operations records model task execution, timing, request sizes, and errors. Use it to establish whether an analysis ran and whether the provider call succeeded.

AI Efficiency provides operational metrics for decisions and traffic around them. Review the selected period and grace window before drawing conclusions.

Execution health

Did the task run? Did it return a valid response? How long did it take? A successful API call answers operational questions.

Security effectiveness

Was the decision correct? Was enforcement confirmed? Were legitimate requests affected? These need evidence and analyst review beyond the success count.

The mitigation worker can defer retries after transient provider failures. A quiet task log can also result from mode gating or no eligible candidates; it does not automatically imply a service outage.

14 / Configure

Access and audit

The permission matrix below is generated from the application’s role definitions, so it follows the current access model.

Role permissions
CapabilityAdminAnalystRead Only
View admin interfaceAllowedAllowedAllowed
Edit settingsAllowedNot allowedNot allowed
Apply entity actionsAllowedAllowedNot allowed
View sensitive settingsAllowedNot allowedNot allowed
Manage usersAllowedNot allowedNot allowed
View admin audit logAllowedNot allowedNot allowed

Admins manage accounts in Users and review changes in Activity. All roles can view the admin interface, but access to individual operations is permission-controlled. A hidden or denied action may be expected for your role.

Administrative history, security decision events, and external enforcement records answer different questions. Correlate their entity and timestamps when reconstructing an action.

15 / Report

Exports and supporting records

  • Queue exports: download the AI decisions CSV or entity blocklist CSV. These links request unfiltered exports.
  • Summary download: use Security Analysis to download the selected narrative as Markdown.
  • Data inspection: use Tables for supporting records when the operational views do not answer a question.

For every export, record the selected filters and generation time. A current-state list and a historical event log will not have the same row count.

Record families for maintainers
RecordPurpose
akamai_logs_minRequest telemetry used by most analytics.
current_entitiesLatest active staged entity evidence.
current_entity_watchlist, current_entity_blocklistEffective local list state.
security_eventsRecorded AI and analyst decisions.
attack_scenario_events_v2Scenario trigger history.
ai_task_runsModel task health and timing.
external_enforcement_eventsProvider write attempts and results.
16 / Operate

Leave a useful handoff

A concise handoff makes the next operator’s review faster. Capture the following alongside the relevant entity or report link:

  • Scope: hostname, entity type/value, and UTC time window.
  • Observation: request counts, rule matches, paths, and what changed.
  • Interpretation: suspected behavior, confidence limits, and benign alternatives.
  • Decision: AI recommendation, policy adjustment, and any analyst override.
  • Outcome: local state, provider result, activation network, and verification still needed.
  • Next review: owner, open question, and when to check again.

Use historical reports for context and handoff. Recheck recent telemetry before making a decision about current activity.

17 / Resolve

Find the next check

Why is there no new AI decision?

Check AI Operations for recent tasks, then review feature switches, the analysis mode, current monitoring mode, hourly limits, and transient retry timing. Check whether staging produced fresh candidates. The current worker skips when no fresh staged entities are eligible, even if older watchlist records remain.

Open AI Operations ↗
Why is a locally blocked entity still sending requests?

Check external enforcement records for disabled or failed integration, correct Client List mapping, and activation network. Confirm the provider-side configuration and propagation. A local block decision, a successful list append, and effective denial at the edge are separate observations.

Read decisions and enforcement →
Why did removing an entity locally not unblock it at Akamai?

The current manual watchlist/remove actions update local state without deleting Akamai Client List entries. Review the provider list and follow your approved provider-side removal process; do not assume the local change reversed the external action.

Why is the dashboard still in attack mode?

Review the last scenario timestamp and monitoring cooldown. A held mode is not itself new attack evidence. Compare current requests and check whether additional scenarios have triggered.

Why is a report missing or showing unavailable metrics?

Check reporting enablement, cadence, and AI task success. The reader shows the latest ten summaries per cadence. Verify that the report window has telemetry and that its dates can be parsed. Missing metrics should not be read as zero activity.

Open Security Analysis ↗
Why did a saved setting not change the next behavior?

Check its runtime scope. Some settings apply on the next request, some on the next worker run, and scheduler settings require a scheduler restart. Compare the job start time with the setting change time.

Why is a notification absent?

Check destination enablement, selected event types, filters, suppression, and delivery logs. A suppressed event and a failed webhook request require different follow-up.

Why is an action unavailable or returning 403?

Check the role permission matrix and your session. Entity actions require Trigger actions permission; changing settings requires Edit settings. Ask an administrator for the appropriate access when needed.

18 / Reference

A shared vocabulary

Entity
An IP, ASN, or TLS fingerprint used to aggregate observations and decisions.
ASN
An autonomous system number associated with a network. It can cover many unrelated users and applications.
TLS fingerprint
A representation of TLS client handshake characteristics. Multiple clients can share it; it is not a certificate.
Watchlist
Local state marking an entity for review. Presence alone does not prove that it has been reevaluated recently.
Alert-bearing request
A request with one or more WAF alert signals. It may also carry deny signals.
Deny-bearing request
A request with one or more provider deny signals. This is distinct from a ClearSOC block recommendation.
Monitoring mode
Recorded baseline, elevated, or attack posture derived from scenarios and cooldown state.
Advisory / enforce
Automated mitigation policy modes. Advisory downgrades model block recommendations; enforce permits them when other policy checks pass.
Confidence
A model-supplied judgment, not a calibrated accuracy metric.
External enforcement
The provider-side update and its effective application, which must be distinguished from local list state.
Current state / event history
Current state shows the effective latest record. Event history records changes over time and can contain multiple events for one entity.