# AimCallbackHandler

> **Class** in `langchain_community`

📖 [View in docs](https://reference.langchain.com/python/langchain-community/callbacks/aim_callback/AimCallbackHandler)

Callback Handler that logs to Aim.

## Signature

```python
AimCallbackHandler(
    self,
    repo: Optional[str] = None,
    experiment_name: Optional[str] = None,
    system_tracking_interval: Optional[int] = 10,
    log_system_params: bool = True,
)
```

## Description

This handler will utilize the associated callback method called and formats
the input of each callback function with metadata regarding the state of LLM run
and then logs the response to Aim.

## Parameters

| Name | Type | Required | Description |
|------|------|----------|-------------|
| `repo (` | `unknown` | Yes | obj:`str`, optional): Aim repository path or Repo object to which Run object is bound. If skipped, default Repo is used. |
| `experiment_name (` | `unknown` | Yes | obj:`str`, optional): Sets Run's `experiment` property. 'default' if not specified. Can be used later to query runs/sequences. |
| `system_tracking_interval (` | `unknown` | Yes | obj:`int`, optional): Sets the tracking interval in seconds for system usage metrics (CPU, Memory, etc.). Set to `None`  to disable system metrics tracking. |
| `log_system_params (` | `unknown` | Yes | obj:`bool`, optional): Enable/Disable logging of system params such as installed packages, git info, environment variables, etc. |

## Extends

- `BaseMetadataCallbackHandler`
- `BaseCallbackHandler`

## Constructors

```python
__init__(
    self,
    repo: Optional[str] = None,
    experiment_name: Optional[str] = None,
    system_tracking_interval: Optional[int] = 10,
    log_system_params: bool = True,
) -> None
```

| Name | Type |
|------|------|
| `repo` | `Optional[str]` |
| `experiment_name` | `Optional[str]` |
| `system_tracking_interval` | `Optional[int]` |
| `log_system_params` | `bool` |


## Properties

- `repo`
- `experiment_name`
- `system_tracking_interval`
- `log_system_params`
- `action_records`

## Methods

- [`setup()`](https://reference.langchain.com/python/langchain-community/callbacks/aim_callback/AimCallbackHandler/setup)
- [`on_llm_start()`](https://reference.langchain.com/python/langchain-community/callbacks/aim_callback/AimCallbackHandler/on_llm_start)
- [`on_llm_end()`](https://reference.langchain.com/python/langchain-community/callbacks/aim_callback/AimCallbackHandler/on_llm_end)
- [`on_llm_new_token()`](https://reference.langchain.com/python/langchain-community/callbacks/aim_callback/AimCallbackHandler/on_llm_new_token)
- [`on_llm_error()`](https://reference.langchain.com/python/langchain-community/callbacks/aim_callback/AimCallbackHandler/on_llm_error)
- [`on_chain_start()`](https://reference.langchain.com/python/langchain-community/callbacks/aim_callback/AimCallbackHandler/on_chain_start)
- [`on_chain_end()`](https://reference.langchain.com/python/langchain-community/callbacks/aim_callback/AimCallbackHandler/on_chain_end)
- [`on_chain_error()`](https://reference.langchain.com/python/langchain-community/callbacks/aim_callback/AimCallbackHandler/on_chain_error)
- [`on_tool_start()`](https://reference.langchain.com/python/langchain-community/callbacks/aim_callback/AimCallbackHandler/on_tool_start)
- [`on_tool_end()`](https://reference.langchain.com/python/langchain-community/callbacks/aim_callback/AimCallbackHandler/on_tool_end)
- [`on_tool_error()`](https://reference.langchain.com/python/langchain-community/callbacks/aim_callback/AimCallbackHandler/on_tool_error)
- [`on_text()`](https://reference.langchain.com/python/langchain-community/callbacks/aim_callback/AimCallbackHandler/on_text)
- [`on_agent_finish()`](https://reference.langchain.com/python/langchain-community/callbacks/aim_callback/AimCallbackHandler/on_agent_finish)
- [`on_agent_action()`](https://reference.langchain.com/python/langchain-community/callbacks/aim_callback/AimCallbackHandler/on_agent_action)
- [`flush_tracker()`](https://reference.langchain.com/python/langchain-community/callbacks/aim_callback/AimCallbackHandler/flush_tracker)

---

[View source on GitHub](https://github.com/langchain-ai/langchain-community/blob/a6a6079511ac8a5c1293337f88096b8641562e77/libs/community/langchain_community/callbacks/aim_callback.py#L136)