> ## Documentation Index
> Fetch the complete documentation index at: https://doc.lucidworks.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Monitoring

export const LwTemplate = ({title = "Key questions to get you started", icon = "sparkles", cta = "Powered by Agent Studio", linkHref = "https://lucidworks.com/demo/?utm_source=docs&utm_medium=referral&utm_campaign=docs_cta_ai"}) => {
  const [isLoaded, setIsLoaded] = useState(false);
  useEffect(() => {
    const timer = setTimeout(() => {
      setIsLoaded(true);
    }, 500);
    return () => clearTimeout(timer);
  }, []);
  return <div className="lw-template-container">
      <Card title={title} icon={icon}>
        {isLoaded && <span dangerouslySetInnerHTML={{
    __html: `<lw-template id="a029c1a9-28be-427e-b0e1-5d918920246a"></lw-template
            >`
  }} />}
        <Link href={linkHref} className="agent-studio-link text-left text-gray-600 gap-2 dark:text-gray-400 text-sm font-medium flex flex-row items-center hover:text-primary dark:hover:text-primary-light group-hover:text-primary group-hover:dark:text-primary-light">Powered by Lucidworks Agent Studio</Link>
      </Card>
    </div>;
};

[localhost link]: http://localhost:3000/docs/4/fusion-server/concepts/system/monitoring/overview

[mintlify link]: https://doc.lucidworks.com/docs/4/fusion-server/concepts/system/monitoring/overview

[old doc.lw link]: https://doc.lucidworks.com/fusion/5.9/132

Fusion Server has functions built in for observability and monitoring with Fusion’s tools or third-party monitoring tools.

<LwTemplate />

## Fusion system metrics

Fusion system metrics are logged and available in the UI, in log files, and through the REST API.

* For an overview of noteworthy metrics that are logged and indexed,
  see [System Metrics](/docs/4/fusion-server/reference/system-metrics).
* See [System Administration with the Fusion UI](/docs/4/fusion-server/concepts/system/overview).
* Read about [System Admin APIs](/docs/4/fusion-server/reference/api/system-admin-apis/overview),
  including APIs for metrics and cluster status, in the REST API Reference Guide.

## Additional tools for monitoring Fusion

* Read about other necessary areas to monitor, such as Java Virtual Machines, Unix file systems, networks, and applications like Solr in [Monitor Fusion 4.x.x](/docs/4/fusion-server/reference/monitoring-fusion-4xx).
* Read about using notifications or alerts in
  [Messaging Service](/docs/4/fusion-server/concepts/system/monitoring/messaging-services).
* Read about monitoring techniques and guidelines in
  [Cluster Monitoring and Troubleshooting](/docs/4/fusion-server/concepts/system/monitoring/cluster-monitoring).
* Read about health checks for components of your Fusion deployment in **Check the System State**.

<Accordion title="Check the System State">
  Fusion runs several components as separate JVMs running on different ports. Each of the components is capable of reporting its status. The proxy component reports status for all of the other components.

  ## Status Check for Zookeeper and connectors-classic

  To see whether each component has been started, a simple API call to the proxy (running on port 8764 by default) will return the status of each component of the system.

  ```bash theme={"dark"}
   curl http://localhost:8764/api
  ```

  The response should look similar to the following. If 'ping' is true for each service, all of the system components are running.

  ```json theme={"dark"}
  {"status":{"db":{"ping":true},"apolloZk":{"ping":true},"apollo":{"ping":true},
  "connectors":{"ping":true},"fusion":{"ping":true}},"startTime":"2018-02-16T16:23:51Z",
  "initMeta":{"initializedAt":"2018-02-15T21:50:43Z","version":"local",
  "nativeRealmInstalled":"2018-02-15T21:53:44Z"},"enabledRealms":[{"name":"native","realmType":"native"},
  {"name":"webapps-jwt-realm","realmType":"jwt"}],"version":"local"}
  ```

  ## Solr Health Check

  The Fusion UI and API services are not accessible if ZooKeeper and Solr are not in healthy state. A Solr health check can be performed with a ping request, for example:

  ```bash theme={"dark"}
  curl http://localhost:8983/solr/_collection-name_/admin/ping
  ```

  The response will be a JSON response, similar to the following:

  ```json theme={"dark"}
  {
    "responseHeader": {
      "zkConnected": true,
      "status": 0,
      "QTime": 0,
      "params": {
        "q": "{!lucene}*:*",
        "distrib": "false",
        "df": "_text_",
        "rows": "10",
        "echoParams": "all"
      }
    },
    "status": "OK"
  }
  ```

  The `status` should be `OK` if Solr is able to return results for queries.

  ## REST API Services Health Check

  All of the Fusion API backend services (except Connectors and the UI) are started at port 8765 when the run.sh script is executed. The Fusion UI depends on all these services.

  If all the services are started without any issues, then the below ping request should return the response `ok`.

  ```bash theme={"dark"}
   curl http://<FUSION_HOST>/api
  ```

  As an alternative check, you can also query the `system/status` endpoint, which returns the status.

  ```bash theme={"dark"}
  curl http://localhost:8764/api/system/status
  ```

  The response looks like something like this:

  ```json theme={"dark"}
  [ {
    "status" : "ok",
    "node" : "http://127.0.0.1:8984/connectors/v1/system",
    "messages" : [ ]
  }, {
    "status" : "ok",
    "node" : "http://127.0.0.1:8764/api/system",
    "messages" : [ ]
  } ]
  ```

  ## Connectors Classic Health Check

  You can perform a health check of the Connectors Classic Service by sending a ping request to port 8984. Similar to the previous ping request, the returned response is `ok` if the service started successfully.

  ```bash theme={"dark"}
   curl http://localhost:8984/connectors/v1
  ```

  As an alternative check, you can also query the `system/status` endpoint, which returns the status.

  ```bash theme={"dark"}
  curl http://localhost:8984/connectors/v1/system/status
  ```

  The response looks like something like this:

  ```json theme={"dark"}
  [ {
    "status" : "ok",
    "node" : "http://127.0.0.1:8984/connectors/v1/system",
    "messages" : [ ]
  }, {
    "status" : "ok",
    "node" : "http://127.0.0.1:8764/api/system",
    "messages" : [ ]
  } ]
  ```
</Accordion>

## For more information

In the Lucidworks Knowledge Base:

* [General guidelines](https://support.lucidworks.com/hc/en-us/articles/18186491585047-Apache-Solr-indexing-performance-guide) about monitoring Solr.

From our blogs:

* An example of [using a third-party tool, Pager Duty, to monitor Fusion](https://lucidworks.com/post/pagerduty-integration-in-lucidworks-fusion/).
