Coralogix provides seamless integration with Vector so you can send your logs from anywhere and parse them according to your needs.

## Prerequisites

- Vector [installed](https://vector.dev/docs/setup/installation/)
- For those customers with a [Kubernetes](https://kubernetes.io/) environment, Helm 2.9+ Package Manager [installed](https://helm.sh/)

## Usage

You must input the following variables when creating a Coralogix logger instance or updating your configuration file:

- `` `api_key` ``: Input your Coralogix [Send-Your-Data API key](https://coralogix.com/docs/user-guides/account-management/api-keys/send-your-data-api-key/index.md).
- `applicationName` and `subystemName`: Input [application and subsystem names](https://coralogix.com/docs/user-guides/account-management/account-settings/application-and-subsystem-names/index.md).
- `coralogix_domain`: Input the Coralogix [domain](https://coralogix.com/docs/user-guides/account-management/account-settings/coralogix-domain/index.md) associated with your account.

## Configuration for Non-Kubernetes Environments

**STEP 1. Edit default configuration file**

Edit the default configuration file vector.toml and paste the following configuration below. Update the following:

- event.log.applicationName = "VECTOR_APP"
- event.log.subsystemName = "VECTOR_SUBSYS"
- uri = Choose the https://ingress.\[[DOMAIN_VALUE]\]/logs/v1/singles endpoint that corresponds to your Coralogix [domain](https://coralogix.com/docs/user-guides/account-management/account-settings/coralogix-domain/index.md) using the domain selector at the top of the page.
- headers.authorization = "Bearer "

```text
# This input is just for test or demo purposes and is supported only since Vector v0.12.0. Feel free to use any other input.

[sources.my_source_id]
  type = "demo_logs" # required
  lines = ["{\"msg\":\"success\", \"code\":200}", "{\"msg\":\"error\", \"code\":500}"] # optional, no default, relevant when [`format`](#format) = `shuffle`
  sequence = false # optional, default, relevant when [`format`](#format) = `shuffle`
  batch_interval = 10
  format = "shuffle"

[transforms.prepare_for_coralogix]
  # General
  type = "lua" # required
  inputs = ["my_source_id"] # required
  version = "2" # required
  # Hooks
  hooks.process = '''
  function (event, emit)
    event.log = {
      applicationName = "VECTOR_APP",
      subsystemName = "VECTOR_SUBSYS",
      json = event.log,
      computerName = os.getenv("HOSTNAME"),
      timestamp = os.time() * 1000
    }
    emit(event)
  end
  '''

[sinks.coralogix]
  # General
  type = "http" # required
  inputs = ["prepare_for_coralogix"] # required
  compression = "none" # optional, default
  method = "post"
  uri = https://ingress.[[DOMAIN_VALUE]]/logs/v1/singles # required
  # Batch
  batch.max_bytes = 1049000 # optional, default, bytes
  batch.timeout_secs = 2 # optional, default, seconds
  # Encoding
  encoding.codec = "json" # required
  # Healthcheck
  #healthcheck.enabled = true # optional, default
  headers.Content-Type = "application/json"
  headers.authorization = "Bearer <API_KEY>"
```

**STEP 2. Add your own sources**

That code will allow you to generate the test traffic. After testing the connection, add your own sources, as in the example below.

```text
[sources.my_source_id]
  type = "file"
  include = ["/var/log/access.log "]
```

You can read more about this configuration [here](https://vector.dev/docs/reference/configuration/).

**STEP 3. Restart Vector**

Remember to restart Vector after every change to load updated configuration.

## Configuration for Kubernetes Environments

**STEP 1. Add Helm chart repo**

```bash
helm repo add vector https://helm.vector.dev
helm repo update
```

**STEP 2. Create an override.yaml file**

Prior to installation create an override.yaml file and paste the following configuration below. Remember to update:

- event.log.applicationName = "VECTOR_APP"
- event.log.subsystemName = "VECTOR_SUBSYS"
- uri = Choose the https://ingress.\[[DOMAIN_VALUE]\]/logs/v1/singles endpoint that corresponds to your Coralogix [domain](https://coralogix.com/docs/user-guides/account-management/account-settings/coralogix-domain/index.md) using the domain selector at the top of the page.
- headers.authorization = "Bearer "

```yaml
# vector override.yaml
---
role: "Agent"

customConfig:
  sources:
    kubernetes_logs:
      type: kubernetes_logs

  transforms:
    prepare_for_coralogix:
      type: lua
      inputs: ["kubernetes_logs"]
      version: "2"
      #hooks
      hooks:
        process: |
            function (event, emit)
              event.log = {
                applicationName = "VECTOR_APP",
                subsystemName = "VECTOR_SUBSYS",
                json = event.log,
                computerName = os.getenv("HOSTNAME"),
                timestamp = os.time() * 1000
              }
              emit(event)
            end

  sinks:
    coralogix:
      type: http
      inputs: ["prepare_for_coralogix"]
      compression: none
      uri: https://ingress.[[DOMAIN_VALUE]]/logs/v1/singles
      batch:
        maxbytes:
          1049000
        timeout_secs:
          2
      encoding:
        codec:
          json
      request:
        headers:
          Content-Type: application/json
          Authorization: "Bearer <<API_key>>"
```

**STEP 3. Deploy the chart**

```bash
helm install vector-agent vector/vector -f override.yaml
```

**STEP 4. Remove the Daemonset**

```bash
helm uninstall vector-agent
```

## Additional resources

|                     |                                                                                             |
| ------------------- | ------------------------------------------------------------------------------------------- |
| Coralogix Endpoints | [Coralogix Endpoints](https://coralogix.com/docs/integrations/coralogix-endpoints/index.md) |

## Support

**Need help?**

Our world-class customer success team is available 24/7 to walk you through your setup and answer any questions that may come up.

Feel free to reach out to us **via our in-app chat** or by sending us an email at [support@coralogix.com](mailto:support@coralogix.com).