GitLab is a DevOps platform that combines the ability to develop, secure, and operate software in a single application. This integration allows you to send logs from your GitLan platform to your Logz.io account.
Configuration
Before you begin, you’ll need:
Download the Logz.io public certificate to your credentials server
For HTTPS shipping, download the Logz.io public certificate to your certificate authority folder.
sudo curl https://raw.githubusercontent.com/logzio/public-certificates/master/AAACertificateServices.crt --create-dirs -o /etc/pki/tls/certs/COMODORSADomainValidationSecureServerCA.crt
Add GitLab as an input
In the Filebeat configuration file (/etc/filebeat/filebeat.yml), add GitLab to the filebeat.inputs section.
GitLab has an advanced logging framework that ships a variety of different system logs. We recommend reading Log system from GitLab and modifying the Filebeat sample configuration according to your needs.
Replace <<LOG-SHIPPING-TOKEN>>
with the token of the account you want to ship to.
# ...
filebeat.inputs:
- type: log
paths:
- /var/log/gitlab/gitlab-rails/production_json.log
fields:
logzio_codec: json
# You can manage your tokens at
# https://app.logz.io/#/dashboard/settings/manage-tokens/log-shipping
token: <<LOG-SHIPPING-TOKEN>>
type: gitlab-production-json
fields_under_root: true
encoding: utf-8
ignore_older: 3h
- type: log
paths:
- /var/log/gitlab/gitlab-rails/production.log
fields:
logzio_codec: plain
# You can manage your tokens at
# https://app.logz.io/#/dashboard/settings/manage-tokens/log-shipping
token: <<LOG-SHIPPING-TOKEN>>
type: gitlab-production
fields_under_root: true
encoding: utf-8
ignore_older: 3h
- type: log
paths:
- /var/log/gitlab/gitlab-rails/api_json.log
fields:
logzio_codec: json
# You can manage your tokens at
# https://app.logz.io/#/dashboard/settings/manage-tokens/log-shipping
token: <<LOG-SHIPPING-TOKEN>>
type: gitlab-api-json
fields_under_root: true
encoding: utf-8
ignore_older: 3h
- type: log
paths:
- /var/log/gitlab/gitlab-rails/application.log
fields:
logzio_codec: json
# You can manage your tokens at
# https://app.logz.io/#/dashboard/settings/manage-tokens/log-shipping
token: <<LOG-SHIPPING-TOKEN>>
type: gitlab-application
fields_under_root: true
encoding: utf-8
ignore_older: 3h
If you’re running Filebeat 8.1+, the type
of the filebeat.inputs
is filestream
instead of logs
:
filebeat.inputs:
- type: filestream
paths:
- /var/log/*.log
If you’re running Filebeat 7, paste this code block. Otherwise, you can leave it out.
# ... For Filebeat 7 only ...
filebeat.registry.path: /var/lib/filebeat
processors:
- rename:
fields:
- from: "agent"
to: "filebeat_agent"
ignore_missing: true
- rename:
fields:
- from: "log.file.path"
to: "source"
ignore_missing: true
If you’re running Filebeat 6, paste this code block.
# ... For Filebeat 6 only ...
registry_file: /var/lib/filebeat/registry
Preconfigured log types
- Production logs in JSON format:
gitlab-production-json
- Production logs in plain text:
gitlab-production
- API logs:
gitlab-api-json
- Application logs:
gitlab-application
The log type is used to apply the appropriate Logz.io preconfigured parsing pipeline so that your logs will be automatically parsed.
The default path to the logs differs, depending on how you’ve installed GitLab:
- If installed from Omnibus packages, the default path is:
/var/log/gitlab/...
- If installed from source:
/home/git/gitlab/log/...
Refer to GitLab Docs to learn more about the Log system.
Set Logz.io as the output
If Logz.io is not an output, add it now. Remove all other outputs.
Replace <<LISTENER-HOST>>
with the host for your region. For example, listener.logz.io
if your account is hosted on AWS US East, or listener-nl.logz.io
if hosted on Azure West Europe.
# ...
output.logstash:
hosts: ["<<LISTENER-HOST>>:5015"]
ssl:
certificate_authorities: ['/etc/pki/tls/certs/COMODORSADomainValidationSecureServerCA.crt']
Start Filebeat
Start or restart Filebeat for the changes to take effect.
Check Logz.io for your logs
Give your logs some time to get from your system to ours, and then open Kibana.
If you still don’t see your logs, see log shipping troubleshooting.