> For the complete documentation index, see [llms.txt](https://bit.lockyzdev.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://bit.lockyzdev.com/docs/2025.1/dev/create-plugins/bit-core-functions/logs.md).

# Logs

Bit employs a custom logging system. To use bits new logging system you simply have to import bit/core and then follow the function structure.

```javascript
const core = require('bit/core');

// Log ERROR as Bit Example plugin
core.log(2, "Bit Example", false, "Something Broke")
// ^ Will output "[ERROR] Bit Example: Something Broke"

// Log WARNING as Bit Example Plugin
core.log(1, "Bit Example", false, "Something Broke")
// ^ Will output "[WARNING] Bit Example: Something Broke"

// Log INFO as Bit Example Plugin
core.log(0, "Bit Example", false, "Something Broke")
// ^ Will output "[INFO] Bit Example: Something Broke"
```

You can also force the log to appear in the bots console regardless of the users settings

```javascript
const core = require('bit/core');

// Force ERROR from Bit Example Plugin to appear in the bots console
core.log(2, "Bit Example", true, "Something Broke")
// ^ Will ALWAYS output "[ERROR] Bit Example: Something Broke"

// Don't Force ERROR from Bit Example Plugin to appear in the bots console
core.log(2, "Bit Example", false, "Something Broke")
// ^ Will only output "[ERROR] Bit Example: Something Broke" if the user has error logs turned on for the console
```


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://bit.lockyzdev.com/docs/2025.1/dev/create-plugins/bit-core-functions/logs.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.