Documentation
¶
Overview ¶
Package log holds the Hertz handlers of the admin audit and message log views and of the log retention settings.
Index ¶
- func FilterAdminActionLogHandler(service Logs) app.HandlerFunc
- func FilterBalanceLogHandler(service Logs) app.HandlerFunc
- func FilterCommissionLogHandler(service Logs) app.HandlerFunc
- func FilterEmailLogHandler(service Logs) app.HandlerFunc
- func FilterGiftLogHandler(service Logs) app.HandlerFunc
- func FilterLoginLogHandler(service Logs) app.HandlerFunc
- func FilterMobileLogHandler(service Logs) app.HandlerFunc
- func FilterOrderLogHandler(service Logs) app.HandlerFunc
- func FilterRegisterLogHandler(service Logs) app.HandlerFunc
- func FilterResetSubscribeLogHandler(service Logs) app.HandlerFunc
- func FilterServerTrafficLogHandler(service Logs) app.HandlerFunc
- func FilterSubscribeLogHandler(service Logs) app.HandlerFunc
- func FilterTrafficLogDetailsHandler(service Logs) app.HandlerFunc
- func FilterUnmatchedPaymentLogHandler(service Logs) app.HandlerFunc
- func FilterUserSubscribeTrafficLogHandler(service Logs) app.HandlerFunc
- func GetLogSettingHandler(service Logs) app.HandlerFunc
- func GetMessageLogListHandler(service Logs) app.HandlerFunc
- func UpdateLogSettingHandler(service Logs) app.HandlerFunc
- type Logs
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func FilterAdminActionLogHandler ¶ added in v1.21.0
func FilterAdminActionLogHandler(service Logs) app.HandlerFunc
FilterAdminActionLogHandler documents Filter admin action log.
@Summary Filter admin action log @Description Pages the administrators' audit trail: settings changes, marketing tasks, ticket actions and Telegram bot commands, with the acting administrator and the request they came from. @Tags admin @Accept json @Produce json @Security BearerAuth @Param request query dto.FilterAdminActionLogRequest false "Request parameters" @Success 200 {object} httpx.ResponseSuccessBean{data=dto.FilterAdminActionLogResponse} @Router /v1/admin/log/admin/list [get]
func FilterBalanceLogHandler ¶
func FilterBalanceLogHandler(service Logs) app.HandlerFunc
FilterBalanceLogHandler documents Filter balance log.
@Summary Filter balance log @Tags admin @Accept json @Produce json @Security BearerAuth @Param request query dto.FilterBalanceLogRequest false "Request parameters" @Success 200 {object} httpx.ResponseSuccessBean{data=dto.FilterBalanceLogResponse} @Router /v1/admin/log/balance/list [get]
func FilterCommissionLogHandler ¶
func FilterCommissionLogHandler(service Logs) app.HandlerFunc
FilterCommissionLogHandler documents Filter commission log.
@Summary Filter commission log @Tags admin @Accept json @Produce json @Security BearerAuth @Param request query dto.FilterCommissionLogRequest false "Request parameters" @Success 200 {object} httpx.ResponseSuccessBean{data=dto.FilterCommissionLogResponse} @Router /v1/admin/log/commission/list [get]
func FilterEmailLogHandler ¶
func FilterEmailLogHandler(service Logs) app.HandlerFunc
FilterEmailLogHandler documents Filter email log.
@Summary Filter email log @Tags admin @Accept json @Produce json @Security BearerAuth @Param request query dto.FilterLogParams false "Request parameters" @Success 200 {object} httpx.ResponseSuccessBean{data=dto.FilterEmailLogResponse} @Router /v1/admin/log/email/list [get]
func FilterGiftLogHandler ¶
func FilterGiftLogHandler(service Logs) app.HandlerFunc
FilterGiftLogHandler documents Filter gift log.
@Summary Filter gift log @Tags admin @Accept json @Produce json @Security BearerAuth @Param request query dto.FilterGiftLogRequest false "Request parameters" @Success 200 {object} httpx.ResponseSuccessBean{data=dto.FilterGiftLogResponse} @Router /v1/admin/log/gift/list [get]
func FilterLoginLogHandler ¶
func FilterLoginLogHandler(service Logs) app.HandlerFunc
FilterLoginLogHandler documents Filter login log.
@Summary Filter login log @Tags admin @Accept json @Produce json @Security BearerAuth @Param request query dto.FilterLoginLogRequest false "Request parameters" @Success 200 {object} httpx.ResponseSuccessBean{data=dto.FilterLoginLogResponse} @Router /v1/admin/log/login/list [get]
func FilterMobileLogHandler ¶
func FilterMobileLogHandler(service Logs) app.HandlerFunc
FilterMobileLogHandler documents Filter mobile log.
@Summary Filter mobile log @Tags admin @Accept json @Produce json @Security BearerAuth @Param request query dto.FilterLogParams false "Request parameters" @Success 200 {object} httpx.ResponseSuccessBean{data=dto.FilterMobileLogResponse} @Router /v1/admin/log/mobile/list [get]
func FilterOrderLogHandler ¶ added in v1.20.1
func FilterOrderLogHandler(service Logs) app.HandlerFunc
FilterOrderLogHandler documents Filter order creation logs.
@Summary Filter order creation logs @Tags admin @Accept json @Produce json @Security BearerAuth @Param request query dto.FilterOrderLogRequest false "Request parameters" @Success 200 {object} httpx.ResponseSuccessBean{data=dto.FilterOrderLogResponse} @Router /v1/admin/log/order/list [get]
func FilterRegisterLogHandler ¶
func FilterRegisterLogHandler(service Logs) app.HandlerFunc
FilterRegisterLogHandler documents Filter register log.
@Summary Filter register log @Tags admin @Accept json @Produce json @Security BearerAuth @Param request query dto.FilterRegisterLogRequest false "Request parameters" @Success 200 {object} httpx.ResponseSuccessBean{data=dto.FilterRegisterLogResponse} @Router /v1/admin/log/register/list [get]
func FilterResetSubscribeLogHandler ¶
func FilterResetSubscribeLogHandler(service Logs) app.HandlerFunc
FilterResetSubscribeLogHandler documents Filter reset subscribe log.
@Summary Filter reset subscribe log @Tags admin @Accept json @Produce json @Security BearerAuth @Param request query dto.FilterResetSubscribeLogRequest false "Request parameters" @Success 200 {object} httpx.ResponseSuccessBean{data=dto.FilterResetSubscribeLogResponse} @Router /v1/admin/log/subscribe/reset/list [get]
func FilterServerTrafficLogHandler ¶
func FilterServerTrafficLogHandler(service Logs) app.HandlerFunc
FilterServerTrafficLogHandler documents Filter server traffic log.
@Summary Filter server traffic log @Tags admin @Accept json @Produce json @Security BearerAuth @Param request query dto.FilterServerTrafficLogRequest false "Request parameters" @Success 200 {object} httpx.ResponseSuccessBean{data=dto.FilterServerTrafficLogResponse} @Router /v1/admin/log/server/traffic/list [get]
func FilterSubscribeLogHandler ¶
func FilterSubscribeLogHandler(service Logs) app.HandlerFunc
FilterSubscribeLogHandler documents Filter subscribe log.
@Summary Filter subscribe log @Tags admin @Accept json @Produce json @Security BearerAuth @Param request query dto.FilterSubscribeLogRequest false "Request parameters" @Success 200 {object} httpx.ResponseSuccessBean{data=dto.FilterSubscribeLogResponse} @Router /v1/admin/log/subscribe/list [get]
func FilterTrafficLogDetailsHandler ¶
func FilterTrafficLogDetailsHandler(service Logs) app.HandlerFunc
FilterTrafficLogDetailsHandler documents Filter traffic log details.
@Summary Filter traffic log details @Tags admin @Accept json @Produce json @Security BearerAuth @Param request query dto.FilterTrafficLogDetailsRequest false "Request parameters" @Success 200 {object} httpx.ResponseSuccessBean{data=dto.FilterTrafficLogDetailsResponse} @Router /v1/admin/log/traffic/details [get]
func FilterUnmatchedPaymentLogHandler ¶ added in v1.21.0
func FilterUnmatchedPaymentLogHandler(service Logs) app.HandlerFunc
FilterUnmatchedPaymentLogHandler documents Filter unmatched payment log.
@Summary Filter unmatched payment log @Description Pages the payments a gateway confirmed that could not settle their order, with the order and trade numbers, the amount and the reason, for manual refunds. @Tags admin @Accept json @Produce json @Security BearerAuth @Param request query dto.FilterUnmatchedPaymentLogRequest false "Request parameters" @Success 200 {object} httpx.ResponseSuccessBean{data=dto.FilterUnmatchedPaymentLogResponse} @Router /v1/admin/log/payment/unmatched/list [get]
func FilterUserSubscribeTrafficLogHandler ¶
func FilterUserSubscribeTrafficLogHandler(service Logs) app.HandlerFunc
FilterUserSubscribeTrafficLogHandler documents Filter user subscribe traffic log.
@Summary Filter user subscribe traffic log @Tags admin @Accept json @Produce json @Security BearerAuth @Param request query dto.FilterSubscribeTrafficRequest false "Request parameters" @Success 200 {object} httpx.ResponseSuccessBean{data=dto.FilterSubscribeTrafficResponse} @Router /v1/admin/log/subscribe/traffic/list [get]
func GetLogSettingHandler ¶
func GetLogSettingHandler(service Logs) app.HandlerFunc
GetLogSettingHandler documents Get log setting.
@Summary Get log setting @Tags admin @Produce json @Security BearerAuth @Success 200 {object} httpx.ResponseSuccessBean{data=dto.LogSetting} @Router /v1/admin/log/setting [get]
func GetMessageLogListHandler ¶
func GetMessageLogListHandler(service Logs) app.HandlerFunc
GetMessageLogListHandler documents Get message log list.
@Summary Get message log list @Tags admin @Accept json @Produce json @Security BearerAuth @Param request query dto.GetMessageLogListRequest false "Request parameters" @Success 200 {object} httpx.ResponseSuccessBean{data=dto.GetMessageLogListResponse} @Router /v1/admin/log/message/list [get]
func UpdateLogSettingHandler ¶
func UpdateLogSettingHandler(service Logs) app.HandlerFunc
UpdateLogSettingHandler documents Update log setting.
@Summary Update log setting @Tags admin @Accept json @Produce json @Security BearerAuth @Param request body dto.LogSetting true "Request parameters" @Success 200 {object} httpx.ResponseSuccessBean @Router /v1/admin/log/setting [post]
Types ¶
type Logs ¶ added in v1.21.0
type Logs interface {
FilterBalanceLog(ctx context.Context, req *dto.FilterBalanceLogRequest) (*dto.FilterBalanceLogResponse, error)
FilterCommissionLog(ctx context.Context, req *dto.FilterCommissionLogRequest) (*dto.FilterCommissionLogResponse, error)
FilterEmailLog(ctx context.Context, req *dto.FilterLogParams) (*dto.FilterEmailLogResponse, error)
FilterGiftLog(ctx context.Context, req *dto.FilterGiftLogRequest) (*dto.FilterGiftLogResponse, error)
FilterLoginLog(ctx context.Context, req *dto.FilterLoginLogRequest) (*dto.FilterLoginLogResponse, error)
FilterMobileLog(ctx context.Context, req *dto.FilterLogParams) (*dto.FilterMobileLogResponse, error)
FilterOrderLog(ctx context.Context, req *dto.FilterOrderLogRequest) (*dto.FilterOrderLogResponse, error)
FilterRegisterLog(ctx context.Context, req *dto.FilterRegisterLogRequest) (*dto.FilterRegisterLogResponse, error)
FilterResetSubscribeLog(ctx context.Context, req *dto.FilterResetSubscribeLogRequest) (*dto.FilterResetSubscribeLogResponse, error)
FilterServerTrafficLog(ctx context.Context, req *dto.FilterServerTrafficLogRequest) (*dto.FilterServerTrafficLogResponse, error)
FilterSubscribeLog(ctx context.Context, req *dto.FilterSubscribeLogRequest) (*dto.FilterSubscribeLogResponse, error)
FilterTrafficLogDetails(ctx context.Context, req *dto.FilterTrafficLogDetailsRequest) (*dto.FilterTrafficLogDetailsResponse, error)
FilterUserSubscribeTrafficLog(ctx context.Context, req *dto.FilterSubscribeTrafficRequest) (*dto.FilterSubscribeTrafficResponse, error)
GetLogSetting(ctx context.Context) (*dto.LogSetting, error)
UpdateLogSetting(ctx context.Context, req *dto.LogSetting) error
GetMessageLogList(ctx context.Context, req *dto.GetMessageLogListRequest) (*dto.GetMessageLogListResponse, error)
FilterAdminActionLog(ctx context.Context, req *dto.FilterAdminActionLogRequest) (*dto.FilterAdminActionLogResponse, error)
FilterUnmatchedPaymentLog(ctx context.Context, req *dto.FilterUnmatchedPaymentLogRequest) (*dto.FilterUnmatchedPaymentLogResponse, error)
}
Logs is the part of the platform facade the log handlers call: the audit and message log views and the log retention settings.
Source Files
¶
- filter_admin_action_log_handler.go
- filter_balance_log_handler.go
- filter_commission_log_handler.go
- filter_email_log_handler.go
- filter_gift_log_handler.go
- filter_login_log_handler.go
- filter_mobile_log_handler.go
- filter_order_log_handler.go
- filter_register_log_handler.go
- filter_reset_subscribe_log_handler.go
- filter_server_traffic_log_handler.go
- filter_subscribe_log_handler.go
- filter_traffic_log_details_handler.go
- filter_unmatched_payment_log_handler.go
- filter_user_subscribe_traffic_log_handler.go
- get_log_setting_handler.go
- get_message_log_list_handler.go
- logs.go
- update_log_setting_handler.go