클래스: Mongo::Mongoing::Event::CommandFailed

상속:
Event::Base
  • 객체
모두 표시
다음을 포함합니다.
안전
다음에 정의됨:
lib/ Mongo/ 모니터링/ 이벤트/command_failed.rb

개요

명령 작업이 실패할 때 발생하는 이벤트입니다.

이후:

  • 2.1.0

상수 요약

Secure에서 포함된 상수

보안::REDACTED_COMMANDS

인스턴스 속성 요약 접기

클래스 메서드 요약 접기

인스턴스 메서드 요약 접기

보안에 포함된 메서드

#compression_allowed?, #redacted, #sensitivity?

생성자 세부 정보

#initialize(command_name, database_name, 주소, request_id, operation_id, 메시지, 실패, 기간, started_event:, server_connection_id: nil, service_id: nil) ⇒ CommandFailed

이 메서드는 비공개 API의 일부입니다. 이 방법은 향후 제거되거나 변경될 수 있으므로 가능하면 사용하지 않는 것이 좋습니다.

새 이벤트를 만듭니다.

예시:

이벤트를 만듭니다.

매개변수:

  • command_name (string) —

    명령의 이름입니다.

  • database_name (string) —

    database_name 이름입니다.

  • 주소 (Server::Address) —

    서버 주소 입니다.

  • request_id (정수) —

    요청 ID입니다.

  • operation_id (정수) —

    작업 ID입니다.

  • 메시지 (string) —

    오류 메시지입니다.

  • 실패 (BSON::Document) —

    오류 문서(있는 경우).

  • 기간 (Float) —

    명령에 소요된 시간(초)입니다.

  • started_event (Monitoring::Event::CommandStarted) —

    해당 시작 이벤트 입니다.

  • service_id (객체) (기본값: nil) —

    서비스 ID(있는 경우)입니다.

이후:

  • 2.1.0



83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
 
# 파일 'lib/ Mongo/ 모니터링/ 이벤트/command_failed.rb', 줄 83

def 초기화(command_name, database_name, 주소,
               request_id, operation_id, 메시지, 실패, 기간,
               started_event:, server_connection_id: nil, service_id: nil)
  @command_name = command_name.to_s
  @database_name = database_name
  @address = 주소
  @request_id = request_id
  @operation_id = operation_id
  @service_id = service_id
  @message = 메시지
  @started_event = started_event
  @failure = 편집됨(command_name, 실패)
  @duration = 기간
  @server_connection_id = server_connection_id
end

인스턴스 속성 세부 정보

#주소 ⇒ Server::Address (읽기 전용)

주소 서버 주소를 반환합니다.

반환합니다:

  • (Server::Address) —

    주소 서버 주소.

이후:

  • 2.1.0



27
28
29
 
# 파일 'lib/ Mongo/ 모니터링/ 이벤트/command_failed.rb', 줄 27

def 주소
  @address
end

#command_name ⇒ string (읽기 전용)

반환값 command_name 명령의 이름입니다.

반환합니다:

  • (string) —

    command_name 명령의 이름입니다.

이후:

  • 2.1.0



30
31
32
 
# 파일 'lib/ Mongo/ 모니터링/ 이벤트/command_failed.rb', 줄 30

def command_name
  @command_name
end

#database_name ⇒ string (읽기 전용)

반환값 database_name database_name의 이름입니다.

반환합니다:

  • (string) —

    database_name database_name의 이름입니다.

이후:

  • 2.1.0



33
34
35
 
# 파일 'lib/ Mongo/ 모니터링/ 이벤트/command_failed.rb', 줄 33

def database_name
  @database_name
end

#duration ⇒ Float (읽기 전용)

반환 시간 명령의 지속 시간(초)입니다.

반환합니다:

  • (Float) —

    duration 명령의 지속 시간(초)입니다.

이후:

  • 2.1.0



36
37
38
 
# 파일 'lib/ Mongo/ 모니터링/ 이벤트/command_failed.rb', 줄 36

def 기간
  @duration
end

#실패 ⇒ BSON::Document (읽기 전용)

오류 문서가 있는 경우 실패를 반환합니다. 이는 MongoDB 서버에서 통신하는 오류에 대해서만 작성됩니다. 네트워크 오류와 같은 다른 상황에서는 이 속성이 nil일 수 있습니다.

반환합니다:

  • (BSON::Document) —

    Failure 오류 문서(있는 경우). 이 정보는 MongoDB 서버 에서 전달하는 오류에 대해서만 작성됩니다. 네트워크 오류와 예시 다른 상황에서는 이 속성이 nil일 수 있습니다.

이후:

  • 2.1.0



42
43
44
 
# 파일 'lib/ Mongo/ 모니터링/ 이벤트/command_failed.rb', 줄 42

def 실패
  @failure
end

#메시지 ⇒ string (읽기 전용)

반환 메시지 오류 메시지입니다. 오류 문서와 달리 오류 메시지는 항상 표시되어야 합니다.

반환합니다:

  • (string) —

    message 오류 메시지입니다. 오류 문서 와 달리 오류 메시지는 항상 표시되어야 합니다.

이후:

  • 2.1.0



46
47
48
 
# 파일 'lib/ Mongo/ 모니터링/ 이벤트/command_failed.rb', 줄 46

def 메시지
  @message
end

#operation_id ⇒ 정수 (읽기 전용)

반환 operation_id 작업 ID입니다.

반환합니다:

  • (정수) —

    operation_id 작업 ID입니다.

이후:

  • 2.1.0



49
50
51
 
# 파일 'lib/ Mongo/ 모니터링/ 이벤트/command_failed.rb', 줄 49

def operation_id
  @operation_id
end

#request_id ⇒ 정수 (읽기 전용)

반환 request_id 요청 ID입니다.

반환합니다:

  • (정수) —

    request_id 요청 ID입니다.

이후:

  • 2.1.0



52
53
54
 
# 파일 'lib/ Mongo/ 모니터링/ 이벤트/command_failed.rb', 줄 52

def request_id
  @request_id
end

#server_connection_id ⇒ 정수 (읽기 전용)

반환값 server_connection_id 서버 연결 ID입니다.

반환합니다:

  • (정수) —

    server_connection_id 서버 연결 ID입니다.

이후:

  • 2.1.0



55
56
57
 
# 파일 'lib/ Mongo/ 모니터링/ 이벤트/command_failed.rb', 줄 55

def server_connection_id
  @server_connection_id
end

#service_id ⇒ nil | 객체 (읽기 전용)

서비스 ID(있는 경우)를 반환합니다.

반환합니다:

  • (nil | 객체) —

    서비스 ID(있는 경우)입니다.

이후:

  • 2.1.0



58
59
60
 
# 파일 'lib/ Mongo/ 모니터링/ 이벤트/command_failed.rb', 줄 58

def service_id
  @service_id
end

#started_event ⇒ Monitoring::Event::CommandStarted (읽기 전용)

이 메서드는 비공개 API의 일부입니다. 이 방법은 향후 제거되거나 변경될 수 있으므로 가능하면 사용하지 않는 것이 좋습니다.

started_event 해당 시작 이벤트 를 반환합니다.

반환합니다:

이후:

  • 2.1.0



64
65
66
 
# 파일 'lib/ Mongo/ 모니터링/ 이벤트/command_failed.rb', 줄 64

def started_event
  @started_event
end

클래스 메서드 세부 정보

.생성(주소, operation_id, 페이로드, 메시지, 실패, 기간, started_event:, server_connection_id: nil, service_id: nil) ⇒ CommandFailed

이 메서드는 비공개 API의 일부입니다. 이 방법은 향후 제거되거나 변경될 수 있으므로 가능하면 사용하지 않는 것이 좋습니다.

유선 프로토콜 메시지 페이로드에서 이벤트를 생성합니다.

예시:

이벤트를 만듭니다.

CommandFailed.generate(address, 1, payload, duration)

매개변수:

  • 주소 (Server::Address) —

    서버 주소 입니다.

  • operation_id (정수) —

    작업 ID입니다.

  • Payload (해시) —

    메시지 페이로드입니다.

  • 메시지 (string) —

    오류 메시지입니다.

  • 실패 (BSON::Document) —

    오류 문서(있는 경우).

  • 기간 (Float) —

    명령의 지속 시간(초)입니다.

  • started_event (Monitoring::Event::CommandStarted) —

    해당 시작 이벤트 입니다.

  • service_id (객체) (기본값: nil) —

    서비스 ID(있는 경우)입니다.

반환합니다:

이후:

  • 2.1.0



129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
 
# 파일 'lib/ Mongo/ 모니터링/ 이벤트/command_failed.rb', 줄 129

def self.생성(주소, operation_id, Payload, 메시지,
                  실패, 기간, started_event:, server_connection_id: nil,
                  service_id: nil)
  신규(
    Payload[:command_name],
    Payload[:database_name],
    주소,
    Payload[:request_id],
    operation_id,
    메시지,
    실패,
    기간,
    started_event: started_event,
    server_connection_id: server_connection_id,
    service_id: service_id
  )
end

인스턴스 메서드 세부 정보

#요약 ⇒ string

참고:

이 방법은 실험적이며 변경될 수 있습니다.

이벤트에 대한 간결하면서도 유용한 요약을 반환합니다.

반환합니다:

  • (string) —

    이벤트의 string 요약입니다.

이후:

  • 2.1.0



106
107
108
 
# 파일 'lib/ Mongo/ 모니터링/ 이벤트/command_failed.rb', 줄 106

def 요약
  "#<#{짧은 클래스_이름} 주소=#{주소} #{database_name}.#{command_name}>"
end