protologbeat 다운로드 - protologbeat 소스 코드 다운로드

protologbeat

기타 카테고리

Version 0.2.0

다운로드

프로토로그비트

설명

이 애플리케이션은 udplogbeat를 대체하기 위한 것입니다. 매우 유사하지만 몇 가지 개선 사항이 있으며 UDP 또는 TCP를 통해 시작할 수 있습니다. 일반 텍스트 또는 JSON 로그를 허용하고 syslog 대상 대체 역할도 할 수 있습니다.

이 폴더가 ${GOPATH}/github.com/harfordfive 위치에 있는지 확인하세요.

Protologbeat 시작하기

구성 옵션

protologbeat.protocol : tcp 또는 udp (기본값: udp)
protologbeat.address : 프로세스가 수신할 주소(기본값: 127.0.0.1)
protologbeat.port : 프로세스가 수신할 포트(기본값 = 5000)
protologbeat.max_message_size : 허용되는 최대 메시지 크기(기본값 = 4096)
protologbeat.json_mode : JSON 형식 메시지만 로깅 활성화(기본값 = false)
protolog.merge_fields_to_root : json_mode가 활성화되면 구문 분석된 필드를 루트 수준으로 병합합니다. (기본값 = false)
protologbeat.default_es_log_type : 이벤트가 지정되지 않은 경우 이벤트에 할당할 Elasticsearch 유형(기본값: protologbeat)
protologbeat.enable_syslog_format_only : syslog 메시지만 허용할지 여부를 나타내는 부울 값입니다. (기본값 = false)
protologbeat.enable_gelf : 프로세스가 GELF 형식의 메시지만 허용하는 모드인지 여부를 나타내는 부울 값
protologbeat.enable_json_validation : json 형식 메시지에 JSON 스키마 유효성 검사를 적용해야 하는지 여부를 나타내는 부울 값(기본값 = false)
protologbeat.validate_all_json_types : json_mode가 활성화되면 모든 유형에 스키마가 지정되어야 하는지 여부를 나타냅니다. 스키마가 없는 유형의 로그 항목은 게시되지 않습니다. (기본값 = false)
protologbeat.json_schema : Elasticsearch 유형을 키로, 절대 로컬 스키마 파일 경로를 값으로 구성된 해시입니다.

구성 예

다음은 protologbeat 섹션에 대한 구성 블록의 예입니다.

일반 텍스트 로깅을 위한 구성 블록
표시된 Elasticsearch 유형에 대해서만 JSON 스키마를 적용하는 구성 블록
모든 Elasticsearch 유형에 대해 JSON 스키마를 적용하는 구성 블록
사용자 정의 ES 유형 'myapp'을 사용하여 syslog 교체를 위한 구성 블록

JSON 스키마는 http://jsonschema.net/의 객체에서 자동으로 생성될 수 있습니다. email_contact 및 stock_item 스키마를 예로 볼 수도 있습니다.

고려사항

Rsyslog를 사용한 로깅에 대한 드롭인 대체 방법으로 이 방법을 사용하려는 경우 이 방법은 데이터를 디스크의 파일에 유지하지 않습니다.
어떤 이유로든 protologbeat가 다운되면 구성된 UDP 포트로 전송된 메시지는 처리되지 않거나 ELK 클러스터로 전송되지 않습니다.
각 메시지가 최소한 한 번 전달된다는 100% 보장이 필요한 경우 이것이 최선의 솔루션이 아닐 수도 있습니다.
로그 이벤트의 일부 손실 가능성이 허용된다면 이것이 합리적인 해결책일 수 있습니다.
이 애플리케이션은 애플리케이션이 동일한 물리적 호스트에서 실행되는 protologbeat에 로깅할 수 있는 시나리오를 위한 것입니다. 서버 간/지역 간/데이터 센터 간 로깅에는 이 기능을 사용하지 않는 것이 좋습니다.
현재 날짜/시간은 protologbeat가 수신하면 각 로그 항목에 자동으로 추가됩니다.
이것이 모든 유형의 필드로 데이터를 기록할 수 있다는 점을 고려하면 protologbeat.template-es2x.json 또는 protologbeat.template.json( ES 5.x ) 인덱스 템플릿에 필요한 필드 이름과 유형을 추가하는 것이 좋습니다.

샘플 클라이언트

다양한 언어로 된 클라이언트의 예는 _samples/ 디렉터리를 참조하세요.

요구사항

골랭 1.7

프로젝트 초기화

Protologbeat를 실행하고 종속성도 설치하려면 다음 명령을 실행하세요.

 make setup

각 주요 단계에 대해 깨끗한 Git 기록을 생성합니다. 변경 사항을 푸시하기 전에 원하는 경우 언제든지 기록을 다시 작성할 수 있습니다.

Protologbeat를 git 저장소에 푸시하려면 다음 명령을 실행하세요.

 git remote set-url origin https://github.com/harfordfive/protologbeat
git push origin master

추가 개발에 대해서는 비트 개발자 가이드를 확인하세요.

짓다

Protologbeat용 바이너리를 빌드하려면 아래 명령을 실행하세요. 그러면 동일한 디렉터리에 protologbeat라는 이름의 바이너리가 생성됩니다.

 make

OSX, Linux 및/또는 Windows용 바이너리를 빌드하려면 다음을 실행할 수 있습니다.

 ./build-bin [TAG_VERSION]

결과 바이너리는 bin/ 디렉터리에 저장됩니다.

달리다

디버깅 출력이 활성화된 상태에서 Protologbeat를 실행하려면 다음을 실행하세요.

 ./protologbeat -c protologbeat.yml -e -d "*"

시험

Protologbeat를 테스트하려면 다음 명령을 실행하세요.

 make testsuite

대안적으로:

 make unit-tests
make system-tests
make integration-tests
make coverage-report

테스트 적용 범위는 ./build/coverage/ 폴더에 보고됩니다.

업데이트

각 비트에는 Elasticsearch의 매핑을 위한 템플릿과 etc/fields.yml 기반으로 자동 생성되는 필드에 대한 문서가 있습니다. etc/protologbeat.template.json 및 etc/protologbeat.asciidoc을 생성하려면

 make update

대청소

Protologbeat 소스 코드를 정리하려면 다음 명령을 실행하세요.

 make fmt
make simplify

빌드 디렉터리와 생성된 아티팩트를 정리하려면 다음을 실행하세요.

 make clean

클론

git 저장소에서 Protologbeat를 복제하려면 다음 명령을 실행하세요:

 mkdir -p ${GOPATH}/github.com/harfordfive
cd ${GOPATH}/github.com/harfordfive
git clone https://github.com/harfordfive/protologbeat

추가 개발에 대해서는 비트 개발자 가이드를 확인하세요.

도커에서 실행

이 비트에 대한 Docker 이미지는 여기에서 찾을 수 있습니다. 컨테이너는 기본 프로토콜/주소/포트를 수신하고 일반 텍스트 메시지를 수락하는 기본 구성으로 시작됩니다. 사용자 정의하려면 샘플 protologbeat.full.yml 구성을 수정하고 원본을 덮어쓰는 고유한 Docker 파일을 생성하세요.