지원 패킷 생성#

plans-img Enterprise 및 Professional 플랜 에서 사용 가능

deployment-img self-hosted 배포

지원 패킷은 고객이 문제를 진단하고 해결하는 데 도움을 주기 위해 사용됩니다. System Console 또는 mmctl system supportpacket 명령을 사용하여 구성 정보, 로그, 플러그인 세부 정보 및 고가용성 클러스터의 모든 노드에 걸친 외부 종속성 데이터를 포함하는 zip 파일을 생성합니다. 비밀번호와 같은 기밀 데이터는 자동으로 제거됩니다.

생성#

중요

지원 패킷을 생성하기 전에 System Console > Environment > Logging 으로 이동하여 Output logs to file 이 true 로 설정되어 있는지 확인하고 File Log Level 을 DEBUG 로 설정하세요.

  1. System Console로 이동하여 System Console 메뉴에서 Commercial Support 를 선택하세요.

    사용 가능한 System Console 메뉴 옵션 예시입니다.

  2. Download Support Packet 을 선택하세요. zip 파일이 로컬 컴퓨터에 다운로드됩니다. 패킷 생성 중에 사용할 수 없는 패킷 파일이 있으면 알림을 받게 됩니다. 자세한 내용은 warning.txt 파일을 참조하세요.

Mattermost 지원팀과 공유할 지원 패킷을 생성하고 다운로드하려면 mmctl system supportpacket 명령을 실행하세요.

go run ./cmd/mmctl system supportpacket

Downloading Support Packet
Downloaded Support Packet to mattermost_support_packet_.zip

기밀 데이터 정리#

Mattermost와 패킷을 공유하기 전에 제외하려는 기밀 데이터를 정리하세요.

패킷 생성 중에 다음 정보가 있는 경우 자동으로 정리됩니다: LdapSettings.BindPassword, FileSettings.PublicLinkSalt, FileSettings.AmazonS3SecretAccessKey, EmailSettings.SMTPPassword, GitLabSettings.Secret, GoogleSettings.Secret, Office365Settings.Secret, OpenIdSettings.Secret, SqlSettings.DataSource, SqlSettings.AtRestEncryptKey, ElasticsearchSettings.Password, All SqlSettings.DataSourceReplicas, All SqlSettings.DataSourceSearchReplicas, MessageExportSettings.GlobalRelaySettings.SmtpPassword, ServiceSettings.SplitKey.

중요

  • 플러그인은 패킷 생성 중에 정리되지 않을 수 있습니다. - Mattermost v10.1부터 플러그인은 구성을 숨김으로 표시할 수 있습니다. 플러그인이 구성을 숨김으로 표시하면 패킷 생성 중에 구성이 정리됩니다. - 그렇지 않은 경우 Mattermost와 공유하기 전에 plugin.json 파일에서 추가 기밀 세부 정보를 정리하세요. 특수 문자가 구성 오류의 일반적인 원인이므로 가능한 경우 동일한 특수 문자를 포함하는 예제 문자열로 세부 정보를 대체하세요.

Mattermost와 패킷 공유#

생성된 지원 패킷을 표준 지원 요청 에 추가하거나 협업 중인 Mattermost 팀과 공유하세요.

중요

지원 패킷을 생성한 후에는 디버그 로깅을 비활성화하세요. 디버그 로깅은 로그 파일을 크게 확장할 수 있으며 서버 성능에 부정적인 영향을 미칠 수 있습니다. 임시로 또는 개발 환경에서만 활성화하고 프로덕션 환경에서는 활성화하지 않는 것을 권장합니다.

지원 패킷의 내용#

Mattermost 지원 패킷에는 다음 파일이 포함될 수 있습니다:

참고

v10.5부터 다음 지원 패킷 데이터가 변경되었습니다:

  • support_packet.yaml 파일이 제거되고 diagnostics.yaml 및 stats.yaml 파일로 분할되었습니다.

  • diagnostics.yaml 의 모든 필드가 가독성 향상을 위해 자체 객체로 이동되었습니다.

  • 필드 이름이 정규화되었습니다.

  • 새로운 데이터에는 서버 통계, 로그, 권한 및 확장된 작업 목록 세부 정보가 포함됩니다.

  • 해당되는 경우 Mattermost 지원 플러그인 진단 데이터가 포함됩니다.

  • metadata.yaml

  • mattermost.log (Mattermost 로그)

  • audit.log (Mattermost 감사 로그)

  • ldap.log (AD/LDAP 로그)

  • notifications.log (알림 로그)

  • plugins.json (모든 활성 및 비활성 플러그인)

  • sanitized_config.json (Mattermost 구성의 정리된 복사본)

  • stats.yaml (Mattermost 사용 통계)

  • jobs.yaml (중요 작업의 마지막 실행)

  • diagnostics.yaml (핵심 플러그인 진단 데이터)

  • permissions.yaml (역할 및 스키마 정보)

  • Go 성능 메트릭, 포함: cpu.prof, heap.prof, 및 goroutines

  • warning.txt (패킷 생성 중 문제가 발생할 때 존재)

  • tsdb_dump.tar.gz (Metrics 플러그인이 설치되어 있고 지원 패킷 생성 시 성능 메트릭 옵션이 선택된 경우 존재)

플러그인이 활성화되어 있고 작동 중일 때 생성된 지원 패킷에 다음 추가 플러그인 진단 데이터가 포함됩니다:

  • GitHub: /github/diagnostics.yaml

  • GitLab: /com.github.manland.mattermost-plugin-gitlab/diagnostics.yaml

  • Jira: /jira/diagnostics.yaml

  • Calls: /com.mattermost.calls/diagnostics.yaml

  • Boards: /focalboard/diagnostics.yaml

  • Playbooks: /playbooks/diagnostics.yaml

  • MSCalendar: /com.mattermost.mscalendar/diagnostics.yaml

  • Google Calendar: /com.mattermost.gcal/diagnostics.yaml

  • metadata.yaml

  • mattermost.log

  • plugins.json

  • sanitized_config.json

  • support_packet.yaml

  • diagnostics.yaml (핵심 플러그인 진단 데이터)

  • Go 성능 메트릭, 포함: cpu.prof, heap.prof, 및 goroutines

  • warning.txt (패킷 생성 중 문제가 발생할 때 존재)

참고

  • 고가용성 배포의 클러스터에 있는 각 노드는 자체 mattermost.log 파일과 고급 로깅 파일(있는 경우)을 가집니다.

  • 지원 패킷 생성 시 LDAP 그룹은 포함되지 않습니다. 존재하는 경우 LDAP Version 과 LDAP Vendor 만 포함됩니다. 이러한 값들은 support_packet.yaml 파일에 포함됩니다.

  • Mattermost v9.11부터 LDAP Vendor 오류가 지원 패킷에 포함됩니다. LDAP Vendor 이름을 가져오는 데 실패하면 지원 패킷 생성 시 오류가 warning.txt 에 포함됩니다. LDAP Vendor 이름을 찾을 수 없는 경우 지원 패킷은 이를 unknown 으로 표시합니다.

  • Mattermost v10.4부터 새로운 diagnostics.yaml 파일에 플러그인 버전, 통화 및 활성 세션 수, 평균 지속 시간 및 참가자 수를 포함한 Mattermost Calls 진단 데이터가 포함됩니다.

메타데이터#

Mattermost v9.11부터 생성된 지원 패킷에는 다음 정보가 포함된 metadata.yaml 파일이 포함됩니다.

필드 이름

필수/선택

설명

예시

버전

필수

현재 메타데이터 파일이 호환되는 스키마의 버전입니다. 현재 버전은 1입니다.

1

유형

필수

패킷의 유형입니다. 각 지원 패킷 유형은 지원 패킷을 생성하는 특정 구성 요소에 매핑될 수 있습니다.

mattermost

생성 시간

필수

패킷이 생성된 날짜와 시간입니다. 값은 epoch(밀리초) 형식입니다.

1707473288731

서버 버전

필수

지원 패킷이 생성된 서버의 버전입니다. Semver 형식이어야 합니다.

9.1.1

서버 ID

필수

서버의 고유 식별자입니다. 26자 이상이어야 합니다.

9qpiszyjr3g8bxda35abcd1234

라이선스 ID

선택

현재 서버 라이선스의 고유 식별자입니다. 26자 이상이어야 합니다. 라이선스가 없을 경우 이 필드는 비어 있습니다.

abcdejisd67yigqhmkz4ho1234

고객 ID

선택

라이선스 파일에 정의된 고객 ID입니다. 26자 이상이어야 합니다. 라이선스가 없을 경우 비어 있습니다.

a1b2c3d4qbbr5cpkbpbmef123h

추가 정보

선택

파일을 생성한 플러그인/구성 요소에 특정한 추가 정보의 키/값입니다. 데이터의 내용을 식별하는 데 유용할 수 있습니다. 이 객체의 내용에 대한 기대치를 설정하기 위해 플러그인(또는 구성 요소) 버전을 추가하는 것을 고려하세요.

extras.plugin_id

플러그인 필수

플러그인의 ID입니다.

extras.plugin_version

플러그인 필수

플러그인의 버전입니다.

예시:

version: 1
type: support-packet
generated_at: 1622569200
server_version: 9.1.1
server_id: 8fqk9rti13fmpxdd5934a3xsxh
license_id: 3g3pqn8in3brzjkozcn1kdidgr
customer_id: 74cmws7gf3ykpj31car7zahsny
extras:
 plugin_version: 0.1.0

Go 성능 메트릭#

지원 패킷에는 3개의 Go 런타임 프로파일링 파일이 포함되어 있습니다:

  • cpu.prof 는 5초 CPU 프로파일을 포함합니다

  • heap.prof 는 힙 프로파일을 포함합니다

  • goroutines 는 실행 중인 모든 Go 루틴의 덤프를 포함합니다

이 파일들은 pprof 를 사용하여 읽을 수 있습니다.

프로파일의 시각화를 브라우저에서 열려면 go tool pprof -web X 를 사용하세요. 여기서 X 는 프로파일의 파일 이름으로 대체됩니다.