> For the complete documentation index, see [llms.txt](https://docs.pharos.ai/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.pharos.ai/configuration-guide/core-metadata.md).

# Core Metadata

Learn about the core package metadata components included with Pharos.

When you install Pharos, a managed package deploys a defined set of metadata components into your Salesforce org. Understanding this footprint helps you evaluate what Pharos adds to your environment and how it integrates with your existing setup.

Pharos is designed to be a lightweight, self-contained package. The components it installs serve specific purposes—from storing observability data to powering the user interface and providing extensibility through global APIs.

{% hint style="info" %}
**Managed Package:** All Pharos metadata is delivered as a managed package, meaning components are namespaced, upgradeable, and cannot accidentally conflict with your custom development.
{% endhint %}

***

## Applications & Tabs

Pharos ships with two Lightning applications and a set of custom tabs that provide the primary navigation experience.

### Pharos Lightning App

The Pharos Lightning app is the central hub for observability. It provides a branded, purpose-built workspace with quick access to all platform features.

| Attribute        | Detail                                                                                 |
| ---------------- | -------------------------------------------------------------------------------------- |
| **App Type**     | Lightning                                                                              |
| **Default Tabs** | Home, Logs, Issues, Trace Schedules, Trace Results, Events, Reports, Dashboards, Admin |
| **Form Factors** | Desktop and Mobile                                                                     |

The package also includes a second application (`Pharos`) covering the same tab set for orgs that have not yet switched navigation to Lightning-only. Most subscribers use the Lightning app described above.

### Custom Tabs

| Tab                 | Purpose                                                  |
| ------------------- | -------------------------------------------------------- |
| **Logs**            | Browse, search, and filter log records                   |
| **Issues**          | Triage, prioritize, and manage grouped errors            |
| **Events**          | View event monitoring records                            |
| **Trace Schedules** | Configure recurring trace operations                     |
| **Trace Results**   | Review trace execution outputs                           |
| **System Overview** | Org-level health dashboard and metrics                   |
| **Pharos Admin**    | Package configuration and settings                       |
| **Inbound Email**   | Records backing the Email-to-Case error-tracking feature |

***

## Custom Objects

Pharos adds a small number of custom objects to your org. The user-facing footprint is deliberately compact—only three objects appear in your daily workflow.

### User-Facing

These are the objects you work with daily. They appear in tabs, list views, reports, and dashboards.

| Object    | API Name   | Purpose                                       |
| --------- | ---------- | --------------------------------------------- |
| **Log**   | `Log__c`   | Individual diagnostic event records           |
| **Issue** | `Issue__c` | Aggregated error clusters with impact metrics |
| **Event** | `Event__c` | Event monitoring records                      |

### Operational

These objects power tracing, rules, and automation features. You interact with them through dedicated Pharos interfaces rather than as raw records.

| Object             | API Name            | Purpose                                          |
| ------------------ | ------------------- | ------------------------------------------------ |
| **Rule**           | `Rule__c`           | Alerting and automation trigger definitions      |
| **Action**         | `Action__c`         | Notification and ticketing action configurations |
| **Trace Request**  | `Trace_Request__c`  | On-demand and scheduled trace operations         |
| **Trace Result**   | `Trace_Result__c`   | Output from completed trace operations           |
| **Trace Schedule** | `Trace_Schedule__c` | Recurring trace configurations                   |
| **Connected Org**  | `Connected_Org__c`  | Multi-org observability connections              |

### Internal

A handful of internal objects support processing, data management, and advanced features. These are managed entirely by Pharos and do not require direct interaction.

| Category            | Objects                                                                        |
| ------------------- | ------------------------------------------------------------------------------ |
| **Processing**      | Limits, Log Index, Rule Filters, Rule Actions, Event Actions                   |
| **Data Management** | Archival Log (Big Object), Sensitive Data Mask, Inbound Email, Change Tracking |

{% hint style="info" %}
**Small Object Footprint:** Pharos adds fewer than 20 custom objects to your org, and only **Logs**, **Issues**, and **Events** are part of your everyday workflow. The rest power rules, tracing, and internal processing behind the scenes.
{% endhint %}

***

## Custom Settings

Pharos uses Salesforce Custom Settings to store platform configuration, integration credentials, and feature flags. These are managed entirely through the Pharos Admin interface and do not appear as tabs or in list views.

| Category           | Settings                                                                                                                                                 |
| ------------------ | -------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **Platform**       | Pharos Settings, Logger Settings, Connected Orgs Settings                                                                                                |
| **Integrations**   | Jira Settings, Jira Fields Mapping, Slack Settings, PagerDuty Settings, Azure DevOps API Settings, Git API Settings, Graph API Settings, Graph API Token |
| **AI & Analytics** | OpenAI Settings, AI Chat Index Settings                                                                                                                  |
| **Data Export**    | Splunk Settings, Splunk Fields *(deprecated)*                                                                                                            |
| **Internal Flags** | Monitoring Batch Flag, Debug Log Service Flag, Log Category Mapping                                                                                      |

{% hint style="info" %}
**Why Custom Settings?** Custom Settings provide a performant, cacheable way to store configuration data without consuming SOQL query limits. Pharos uses them to keep integration credentials and feature toggles accessible to its processing engine without impacting your org's governor limits.
{% endhint %}

***

## Lightning Components

Pharos includes Lightning Web Components that deliver rich, interactive experiences on record pages and within the Pharos app.

### Record Page Components

These components are placed on Log and Issue record pages to provide contextual visualizations and tools.

| Component                 | Placement           | What It Does                                              |
| ------------------------- | ------------------- | --------------------------------------------------------- |
| **Pharos Chart**          | Log / Issue detail  | Interactive charts showing occurrence trends and patterns |
| **Stacktrace Viewer**     | Log detail          | Visual stack trace navigation with code context           |
| **Log Limits Chart**      | Log detail          | Governor limit consumption visualization                  |
| **Log Related Objects**   | Log detail          | Related records and cross-reference navigation            |
| **Issue Related Objects** | Issue detail        | Aggregate impact data and related record navigation       |
| **Trace Result**          | Trace Result detail | Trace execution output viewer                             |
| **Pharos Chat**           | Log / Issue detail  | AI-powered analysis and Org Genie interface               |
| **Event Record Details**  | Event detail        | Event monitoring record viewer                            |

### App-Level Components

| Component               | Purpose                                                            |
| ----------------------- | ------------------------------------------------------------------ |
| **System Overview**     | Org-wide health dashboard accessible from Home and a dedicated tab |
| **Error Report Action** | Quick action for submitting error reports                          |

***

## Global Apex APIs

Pharos exposes a set of `global` Apex classes that form the public API surface of the managed package. These classes primarily serve as the underlying engine for the **Pharos Triton** logging framework—an open-source instrumentation layer that provides structured, developer-friendly logging for Apex, Flows, and LWC.

{% hint style="info" %}
**Pharos Triton:** Rather than using the global Apex APIs directly, developers work with the Triton framework, which provides a higher-level, well-documented interface for custom instrumentation. Triton documentation and source code are available at [triton.pharos.ai](https://triton.pharos.ai).
{% endhint %}

In total, the package exposes roughly **20 global classes and interfaces**. A representative sample:

| Category                      | Classes                                                                                                                                     | Role                                                                                                                    |
| ----------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- |
| **Logging Engine**            | `Logger`, `LogService`, `LogBuilder`                                                                                                        | Core API layer that Triton builds upon for log capture and processing                                                   |
| **External REST API**         | `LogRestService`                                                                                                                            | REST endpoint for pulling log data into external systems such as data warehouses or third-party observability platforms |
| **Internal REST Services**    | `FlowRestService`, `JiraPluginWebService`, `PharosMcpRestResource`                                                                          | Endpoints supporting Pharos platform features and integration webhooks                                                  |
| **HTTP Utilities**            | `HttpRequestWrapper`, `HttpResponseWrapper`                                                                                                 | Helper wrappers for outbound callouts                                                                                   |
| **Error Parsing**             | `ErrorEmailHandler`, `Email2CaseParser`, `Web2LeadParser`, `ApexExceptionParser`, `FlowExceptionParser`, `IErrorParser`, `ICustomErrorInfo` | Parse and classify inbound error sources                                                                                |
| **Chart & Trace Controllers** | `EventsChartsWrapperController`, `LogsChartsWrapperController`, `StacktraceViewerController`                                                | Support Lightning component data access                                                                                 |

***

## Platform Events

Pharos uses two high-volume platform events for asynchronous processing within its architecture.

| Event         | API Name       | Purpose                                                 |
| ------------- | -------------- | ------------------------------------------------------- |
| **Log Event** | `Log_Event__e` | Drives the Triton log ingestion and processing pipeline |
| **AI Event**  | `AI_Event__e`  | Handles AI-powered analysis requests                    |

Both events use the `PublishImmediately` behavior and are consumed by Pharos's internal subscribers.

***

## Flows

The package includes screen flows that support issue management workflows.

| Flow                     | Purpose                                                       |
| ------------------------ | ------------------------------------------------------------- |
| **Mark Issue Duplicate** | Mark an issue as a duplicate and link it to the primary issue |
| **Not A Duplicate**      | Reverse a duplicate designation                               |
| **Link Issue**           | Create relationships between related issues                   |

***

## Custom Metadata Types

Pharos uses a small number of custom metadata types for internal configuration that persists across deployments and sandbox refreshes.

| Metadata Type                  | Visibility | Purpose                                                                  |
| ------------------------------ | ---------- | ------------------------------------------------------------------------ |
| **OAuthSettings**              | Protected  | OAuth connection credentials for integrations                            |
| **AWS Token**                  | Protected  | Token storage for AI service connectivity                                |
| **AI Metadata** *(deprecated)* | Public     | Legacy AI service credential storage, retained for upgrade compatibility |

{% hint style="warning" %}
**Protected Metadata:** Integration-related custom metadata types are marked as `Protected`, meaning they are managed exclusively through Pharos configuration interfaces and are not directly accessible to subscribers.
{% endhint %}

***

## Package Summary

A high-level view of the complete Pharos metadata footprint.

| Component Type            | Count                    | Notes                                                               |
| ------------------------- | ------------------------ | ------------------------------------------------------------------- |
| **Custom Objects**        | \~18                     | 3 user-facing, remainder are operational and internal               |
| **Custom Settings**       | \~16                     | Platform configuration, integration credentials, feature flags      |
| **Custom Tabs**           | 8                        | Logs, Issues, Events, Traces, System Overview, Inbound Email, Admin |
| **Lightning Components**  | 10+ exposed              | Record page visualizations and app-level tools                      |
| **Global Apex Classes**   | \~20                     | Triton logging engine, REST services, HTTP utilities                |
| **Platform Events**       | 2                        | Log and AI processing pipelines                                     |
| **Flows**                 | 3                        | Issue management workflows                                          |
| **Custom Metadata Types** | 2 active (+1 deprecated) | Integration credential storage                                      |
| **Applications**          | 2 Lightning apps         | Pharos Lightning (primary) plus a secondary Pharos app              |

{% hint style="success" %}
**Minimal Footprint, Maximum Value:** Pharos delivers comprehensive observability through a compact, well-organized set of metadata components. The package is designed to integrate seamlessly into your org without impacting your existing customizations or consuming unnecessary resources.
{% endhint %}
