قالب گزارش/تاریخ/زمان (LOG/DATE/TIME FORMAT)

--time-format=<timeformat>

متغیر time-format که به دنبال آن یک فاصله می‌آید، زمانِ قالب گزارش را مشخص می‌کند که شامل نام یکی از قالب‌های از‌پیش‌تعریف‌شده (گزینه‌های زیر را ببینید) یا هر ترکیبی از نویسه‌های معمولی و مشخص‌کننده‌های ویژه قالب است.

همگی با علامت درصد (%) شروع می‌شوند. به `man strftime` مراجعه کنید. %T یا %H:%M:%S.

توجه داشته باشید که اگر یک برچسب زمانی (timestamp) بر حسب میکروثانیه داده شده باشد، %f باید به عنوان time-format استفاده شود. اگر برچسب زمانی بر حسب میلی‌ثانیه داده شده باشد، %* باید به عنوان time-format استفاده شود.

--date-format=<dateformat>

متغیر date-format که به دنبال آن یک فاصله می‌آید، تاریخِ قالب گزارش را مشخص می‌کند که شامل نام یکی از قالب‌های از‌پیش‌تعریف‌شده (گزینه‌های زیر را ببینید) یا هر ترکیبی از نویسه‌های معمولی و مشخص‌کننده‌های ویژه قالب است.

همگی با علامت درصد (%) شروع می‌شوند. به `man strftime` مراجعه کنید. %Y-%m-%d.

توجه داشته باشید که اگر یک برچسب زمانی بر حسب میکروثانیه داده شده باشد، %f باید به عنوان date-format استفاده شود. اگر برچسب زمانی بر حسب میلی‌ثانیه داده شده باشد، %* باید به عنوان date-format استفاده شود.

--datetime-format=<date_time_format>

قالب تاریخ و زمان، این دو متغیر را در یک گزینه واحد ترکیب می‌کند. این قابلیت امکان دریافت منطقه زمانی (timezone) از یک درخواست و تبدیل آن به یک منطقه زمانی دیگر را در خروجی فراهم می‌سازد. ببینید: --tz=<timezone>

همگی با علامت درصد (%) شروع می‌شوند. به `man strftime` مراجعه کنید؛ برای مثال: %d/%b/%Y:%H:%M:%S %z.

توجه داشته باشید که در صورت استفاده از --datetime-format، %x باید در متغیر log-format فرستاده شود تا فیلد تاریخ و زمان را نشان دهد.

--log-format=<logformat>

متغیر log-format که به دنبال آن یک فاصله یا \t برای تفکیک با تب (tab-delimited) می‌آید، رشته قالب گزارش را مشخص می‌کند.

توجه داشته باشید که اگر درون قالب فاصله وجود دارد، رشته باید درون علامت‌های نقل‌قول تکی یا دوتایی قرار گیرد. نقل‌قول‌های داخلی باید گریز داده شوند (escaped شوند).

علاوه بر مشخص کردن قالب‌های خامِ گزارش/تاریخ/زمان، برای سهولت کار، هر یک از نام‌های قالب گزارش از‌پیش‌تعریف‌شده زیر را می‌توان برای متغیرهای log/date/time-format تعیین کرد. GoAccess همچنین می‌تواند یک نام از‌پیش‌تعریف‌شده را در یک متغیر و نام از‌پیش‌تعریف‌شده دیگری را در متغیر دیگر به کار گیرد.

COMBINED - Combined Log Format,
VCOMBINED - Combined Log Format with Virtual Host,
COMMON - Common Log Format,
VCOMMON - Common Log Format with Virtual Host,
W3C - W3C Extended Log File Format,
SQUID - Native Squid Log Format,
CLOUDFRONT - Amazon CloudFront Web Distribution,
CLOUDSTORAGE - Google Cloud Storage,
AWSELB - Amazon Elastic Load Balancing,
AWSS3 - Amazon Simple Storage Service (S3)
AWSALB - Amazon Application Load Balancer
CADDY - Caddy's JSON Structured format (local/info format)
TRAEFIKCLF - Traefik's CLF flavor

نکته: به‌طور کلی، مقادیری که شامل فاصله (whitespace)، ویرگول، پایپ (|)، نقل‌قول یا براکت هستند نیاز به نقل‌قول (کوتیشن) دارند. نقل‌قول‌های داخلی باید escape شوند.

نکته: هدایت داده‌ها با لوله‌کشی (Piping) به GoAccess کادر محاوره‌ای پیکربندی گزارش/تاریخ/زمان را نمایش نخواهد داد؛ بنابراین باید از قبل آن را در فایل پیکربندی یا در خط فرمان تعریف کرده باشید.

نکته: قالب پیش‌فرض GoAccess برای CADDY، قالب 'local/info' است. با این حال در صورت نیاز، می‌توانید از یک قالب گزارش سفارشی در GoAccess برای مطابقت با پیکربندی خاص خود استفاده کنید..SS گزینه‌های رابط کاربری (USER INTERFACE OPTIONS)

-c --config-dialog

پنجره پیکربندی لاگ/زمان/تاریخ را هنگام شروع برنامه نمایش می‌دهد. تنها زمانی که curses مقداردهی اولیه شده باشد.

-i --hl-header

پنل فعال ترمینال را با رنگ برجسته (هایلایت) می‌کند.

-m --with-mouse

پشتیبانی از موش‌واره (ماوس) را در داشبورد اصلی ترمینال فعال می‌کند.

---color=<fg:bg[attrs, PANEL]>

رنگ‌های سفارشی را برای خروجی ترمینال تعیین می‌کند.

نحو رنگ (Color Syntax)
DEFINITION space/tab colorFG#:colorBG# [attributes,PANEL]

FG# = رنگ پیش‌زمینه [-1...255] (-1 = رنگ پیش‌فرض ترمینال)
BG# = رنگ پس‌زمینه [-1...255] (-1 = رنگ پیش‌فرض ترمینال)

به صورت اختیاری، اعمال ویژگی‌های رنگ امکان‌پذیر است (ویژگی‌های چندگانه با کاما جدا می‌شوند)، مانند: bold, underline, normal, reverse, blink

در صورت تمایل، اعمال رنگ‌های سفارشی به ازای هر پنل امکان‌پذیر است؛ به این معنی که یک معیار در پنل REQUESTS می‌تواند به رنگ A باشد، در حالی که همان معیار در پنل BROWSERS می‌تواند به رنگ B باشد.

تعاریف رنگی موجود:
COLOR_MTRC_HITS
COLOR_MTRC_VISITORS
COLOR_MTRC_DATA
COLOR_MTRC_BW
COLOR_MTRC_AVGTS
COLOR_MTRC_CUMTS
COLOR_MTRC_MAXTS
COLOR_MTRC_PROT
COLOR_MTRC_MTHD
COLOR_MTRC_HITS_PERC
COLOR_MTRC_HITS_PERC_MAX
COLOR_MTRC_VISITORS_PERC
COLOR_MTRC_VISITORS_PERC_MAX
COLOR_PANEL_COLS
COLOR_BARS
COLOR_ERROR
COLOR_SELECTED
COLOR_PANEL_ACTIVE
COLOR_PANEL_HEADER
COLOR_PANEL_DESC
COLOR_OVERALL_LBLS
COLOR_OVERALL_VALS
COLOR_OVERALL_PATH
COLOR_ACTIVE_LABEL
COLOR_BG
COLOR_DEFAULT
COLOR_PROGRESS

برای نمونه‌ای از طرح رنگ، فایل پیکربندی را ببینید.

--color-scheme=<1|2|3>

انتخاب میان طرح‌های رنگی. 1 برای طرح خاکستری پیش‌فرض. 2 برای طرح سبز. 3 برای طرح Monokai (تنها در صورتی نمایش داده می‌شود که ترمینال از ۲۵۶ رنگ پشتیبانی کند).

--crawlers-only

تنها خزنده‌ها (ربات‌ها) را تجزیه و نمایش می‌دهد.

--html-custom-css=<path/custom.css>

مسیر یک فایل CSS سفارشی را برای بارگذاری در گزارش HTML مشخص می‌کند.

--html-custom-js=<path/custom.js>

مسیر یک فایل JS سفارشی را برای بارگذاری در گزارش HTML مشخص می‌کند.

--html-report-title=<title>

عنوان صفحه و سرآیند گزارش HTML را تنظیم می‌کند.

--html-refresh=<secs>

گزارش HTML را هر X ثانیه تازه‌سازی می‌کند. این مقدار باید عددی بین ۱ تا ۶۰ ثانیه باشد. مقدار پیش‌فرض روی تازه‌سازی گزارش HTML در هر ۱ ثانیه تنظیم شده است.

--html-prefs=<JSON>

تنظیمات ترجیحی پیش‌فرض گزارش HTML را تعیین می‌کند. یک شیء JSON معتبر حاوی ترجیحات HTML ارائه دهید. این گزینه امکان سفارشی‌سازی نمودار هر پنل را فراهم می‌کند. مثال زیر را ببینید.

نکته: شیء JSON ارائه‌شده باید یک رشته JSON تک‌خطی باشد. برای نمونه،

--html-prefs='{"theme":"bright","perPage":5,"layout":"horizontal","showTables":true,"visitors":{"plot":{"chartType":"bar"}}}'

--json-pretty-print

خروجی JSON را با استفاده از تب‌ها و خطوط جدید قالب‌بندی می‌کند.

نکته: استفاده از این گزینه هنگام ایجاد گزارش HTML بلادرنگ (real-time) توصیه نمی‌شود، زیرا اندازه بار داده (payload) در WebSocket بسیار بزرگ‌تر خواهد شد.

--max-items=<number>

حداکثر تعداد موارد برای نمایش در هر پنل. این بیشینه می‌تواند عددی بین ۱ تا n باشد.

نکته: تنها خروجی CSV و JSON اجازه تعیین مقداری بیشتر از مقدار پیش‌فرض ۳۶۶ مورد در هر پنل (یا ۵۰ در خروجی HTML بلادرنگ) را می‌دهند.

--no-color

خروجی رنگی را غیرفعال می‌کند. این خروجی پیش‌فرض در ترمینال‌هایی است که از رنگ پشتیبانی نمی‌کنند.

--no-csv-summary

معیارهای خلاصه را در خروجی CSV غیرفعال می‌کند.

--no-progress

معیارهای پیشرفت [کل درخواست‌ها/درخواست‌ها در ثانیه] را غیرفعال می‌کند.

--no-tab-scroll

پیمایش میان پنل‌ها هنگام فشردن کلید TAB یا زمانی که یک پنل با استفاده از کلید عددی انتخاب می‌شود را غیرفعال می‌کند.

--no-html-last-updated

فیلد آخرین به‌روزرسانی (last updated) نمایش داده‌شده در گزارش تولیدی HTML را نشان نمی‌دهد.

--no-parsing-spinner

معیارهای پیشرفت و اسپینر تجزیه را نمایش نمی‌دهد.

--tz=<timezone>

داده‌های تاریخ/زمان گزارش را در منطقه زمانی مشخص‌شده خروجی می‌دهد. توجه داشته باشید که این گزینه از نام استاندارد منطقه زمانی (canonical timezone name) استفاده می‌کند؛ مانند: Europe/Berlin یا America/Chicago یا Africa/Cairo اگر نام منطقه زمانی نامعتبر داده شود، خروجی بر اساس GMT خواهد بود. برای تعیین صحیح منطقه زمانی در قالب تاریخ/زمان، گزینه --datetime-format را ببینید..SS "گزینه‌های سرور (SERVER OPTIONS)"

نکته این بخش تنها یک سرور WebSocket برای ارائه داده‌های خام بی‌درنگ است. این ابزار به خودیِ خود یک WebServer نیست. برای دسترسی به فایل html گزارش‌هایتان، همچنان به سرور HTTP خود نیاز خواهید داشت؛ فایل گزارش تولیدشده را در دایرکتوری ریشه اسناد (document root) آن قرار دهید و فایل html را در مرورگر خود باز کنید. سپس مرورگر اتصال WebSocket دیگری به سرور ws که ممکن است در اینجا برپا کنید برقرار می‌کند تا داشبورد را به‌روز نگه دارد.

--addr

آدرس IP را برای مقید کردن (bind) سرور به آن مشخص می‌کند. در غیر این صورت به 0.0.0.0 مقید می‌شود.

معمولاً نیازی به مشخص کردن آدرس نیست، مگر اینکه عمداً بخواهید سرور را به آدرس دیگری درون سرور خود مقید کنید.

--daemonize

اجرای GoAccess به عنوان دیمن (daemon) (تنها در صورت فعال بودن --real-time-html).

نکته: مهم است که در سراسر پیکربندی GoAccess از مسیرهای مطلق استفاده شود.

--user-name=<username>

اجرای GoAccess با کاربر مشخص‌شده.

نکته: مهم است مطمئن شوید کاربر یا گروه کاربری مربوطه می‌تواند به فایل‌های ورودی و خروجی و همچنین هر فایل مورد نیاز دیگری دسترسی داشته باشد. سایر گروه‌هایی که کاربر عضو آن‌هاست نادیده گرفته خواهند شد. از این رو توصیه می‌شود GoAccess در پشت یک پروکسی SSL اجرا شود، زیرا بعید است این کاربر بتواند به گواهی‌های SSL دسترسی داشته باشد.

--origin=<url>

اطمینان حاصل می‌کند که کلاینت‌ها هنگام دست‌تکانی (handshake) اولیه WebSocket، هدر origin مشخص‌شده را ارسال کنند.

--pid-file=<path/goaccess.pid>

در صورت استفاده به همراه گزینه --daemonize، شناسه فرایند (PID) دیمن را در یک فایل می‌نویسد.

--port=<port>

پورت مورد استفاده را مشخص می‌کند. به صورت پیش‌فرض، سرور WebSocket برنامه GoAccess روی پورت 7890 گوش می‌دهد.

--real-time-html

خروجی HTML بی‌درنگ را فعال می‌کند.

برنامه GoAccess از سرور WebSocket اختصاصی خود برای ارسال (push) داده‌ها از سرور به کلاینت استفاده می‌کند. برای جزئیات بیشتر در مورد نحوه کارکرد سرور WebSocket به http://gwsocket.io مراجعه کنید.

--ws-auth=<jwt[:secret]> | jwt:verify:secret

احراز هویت WebSocket را با استفاده از یک JSON Web Token (JWT) فعال می‌کند. این گزینه بسته به اینکه JWT به صورت محلی تولید شده یا از خارج دریافت و اعتبارسنجی شود، از دو قالب پشتیبانی می‌کند:

<jwt[:secret]>: یک JWT ایستا را برای احراز هویت WebSocket، به همراه یک کلید محرمانه (secret) اختیاری برای تولید یا اعتبارسنجی محلی مشخص می‌کند. اگر تنها "jwt" ارائه شود (برای نمونه، --ws-auth=jwt)، GoAccess با استفاده از کلید محرمانه‌ای که از متغیر محیطی GOACCESS_WSAUTH_SECRET گرفته شده یا یک کلید پیش‌فرض سازگار با HS256 در صورت تنظیم نشدن، یک JWT تولید می‌کند. اگر یک کلید محرمانه گنجانده شود (برای نمونه، --ws-auth=jwt:mysecret)، مستقیماً به عنوان کلید امضای HS256 استفاده می‌شود، یا اگر مقدار یک مسیر معتبر باشد (برای نمونه، --ws-auth=jwt:/path/to/secret.key)، از فایل خوانده می‌شود.

jwt:verify:secret: اعتبارسنجی یک JWT دریافت‌شده از خارج را فعال می‌کند (برای نمونه، از طریق --ws-auth-url). کلمه کلیدی "verify" نشان می‌دهد که JWT توسط یک منبع خارجی ارائه شده است و کلید محرمانه باید برای اعتبارسنجی مشخص شود. این کلید می‌تواند یک کلید مستقیم HS256 (برای نمونه، --ws-auth=jwt:verify:mysecret)، یک مسیر فایل (برای نمونه، --ws-auth=jwt:verify:/path/to/secret.key) یا نام یک متغیر محیطی (برای نمونه، --ws-auth=jwt:verify:$JWT_SECRET) باشد. این قالب هنگام استفاده از --ws-auth-url و به صورت اختیاری --ws-auth-refresh-url برای دریافت و اعتبارسنجی JWTها از نقاط پایانی خارجی الزامی است.

هنگام استفاده از این گزینه، گزارش HTML داده‌های اولیه‌ٔ تجزیه‌شده را راه‌اندازی (bootstrap) نمی‌کند. در عوض، تنها در صورت موفقیت‌آمیز بودن احراز هویت، گزارش را نمایش می‌دهد و دسترسی امن به داده‌های بی‌درنگ را تضمین می‌کند.

سیستم این گزینه را به صورت زیر پردازش می‌کند:

برای <jwt[:secret]>: اگر هیچ کلید محرمانه‌ای ارائه نشود، GoAccess یک JWT را به صورت محلی با استفاده از متغیر محیطی GOACCESS_WSAUTH_SECRET یا یک کلید پیش‌فرض تولید می‌کند. اگر کلید محرمانه‌ای مشخص شود، برای امضای JWT (به صورت مستقیم یا از طریق یک فایل) به کار می‌رود.

برای jwt:verify:secret: کلید محرمانه اجباری است و برای اعتبارسنجی JWTهای دریافت‌شده از خارج استفاده می‌شود. این کلید باید با کلید امضای مورد استفاده توسط سرور احراز هویت خارجی (برای نمونه، در --ws-auth-url) مطابقت داشته باشد.

نیازمند ساخت GoAccess با --with-openssl. است.

--ws-auth-expire=<secs>

زمانی را تنظیم می‌کند که پس از آن JWT منقضی می‌شود. در صورت مشخص نشدن، به طور پیش‌فرض 8 ساعت (28800 ثانیه) است.

تنها برای JWT تولیدشده به صورت محلی در دسترس است.

کاربران می‌توانند زمان انقضا را در قالب‌های گوناگون مشخص کنند. این مقدار برای اعتبارسنجی انقضای JWT به ثانیه تبدیل می‌شود. قالب‌های پشتیبانی‌شده:

زمان انقضا مشخص می‌کند که JWT پس از صدور تا چه مدت معتبر بماند و از این طریق اتصالات امن WebSocket را تضمین می‌کند.

--ws-auth-url=<url>

آدرسی (URL) را مشخص می‌کند که GoAccess از آنجا JWT اولیه را برای احراز هویت اتصال WebSocket دریافت می‌کند.

هنگام استفاده از این گزینه، GoAccess یک درخواست GET به URL مشخص‌شده ارسال می‌کند تا JWT اولیه را دریافت کند. پاسخ باید یک شیء JSON شامل فیلدهای status، access_token، refresh_token و expires_in باشد.

مثال: --ws-auth-url=https://site.com/api/get-auth-token

هنگام دریافت توکن، GoAccess از { credentials: 'include' } به عنوان بخشی از درخواست استفاده می‌کند تا توکن دسترسی را به صورت امن و بر اساس نشست احراز هویتِ موجودِ کاربر در سیستم شما بازیابی کند؛ این امر تضمین می‌کند که تا زمان معتبر بودن احراز هویت کاربران، دریافت توکن ایمن خواهد بود.

این گزینه به شما اجازه می‌دهد تا با استفاده از نقاط پایانی دریافت توکن، سیستم احراز هویت موجود خود را با داشبورد GoAccess یکپارچه‌سازی کنید.

--ws-auth-refresh-url=<url>

آدرسی (URL) را مشخص می‌کند که GoAccess در زمانی که توکن فعلی نزدیک به انقضا است، یک JWT جدید را از آن دریافت می‌کند.

برنامه GoAccess به طور پیش‌دستانه ۶۰ ثانیه قبل از انقضا، با ارسال یک درخواست POST همراه با refresh_token به این URL، توکن JWT را تازه‌سازی می‌کند. در صورت ارائه نشدن، پیش‌فرض آن همان URL مشخص‌شده در --ws-auth-url خواهد بود.

مثال: --ws-auth-refresh-url=https://site.com/api/refresh-token

قالب پاسخ باید با ساختار پاسخِ URL احراز هویت اولیه مطابقت داشته باشد..SS "روند احراز هویت WebSocket"

برنامه GoAccess گزینه‌های احراز هویت منعطفی را ارائه می‌دهد و از هر دو رویکرد بدون‌وضعیت (stateless) و با‌وضعیت (stateful) پشتیبانی می‌کند. در رویکرد بدون‌وضعیت، توکن نوسازی (refresh token) بدون کوکی‌ها یا محافظت CSRF به دست می‌آید؛ سمت سرور (backend) شما امضای توکن نوسازی را اعتبارسنجی کرده و توکن دسترسی (access token) جدیدی صادر می‌کند. در مقابل، رویکرد با‌وضعیت به واکشی اولیه اجازه می‌دهد تا توکن‌های JWT را به همراه یک `csrf_token` که در نشست (session) ذخیره می‌شود صادر کند. سپس درخواست نوسازی بعدی (POST) بررسی CSRF را انجام داده و تطابق هدر `X-CSRF-TOKEN` با توکن نشست را الزامی می‌داند.

احراز هویت اولیه:

نوسازی توکن:

اعتبارسنجی دوره‌ای توکن:

نکته مهم: برای کارکرد این گزینه‌ها، باید --ws-auth=jwt:verify:<secret> را مشخص کنید که در آن <secret> می‌تواند موارد زیر باشد:

مثال: --ws-auth=jwt:verify:/path/to/secret.key

--ws-url=<[scheme://]url[:port]>

نشانی URL که کارساز WebSocket به آن پاسخ می‌دهد. این همان URLای است که به سازنده WebSocket در سمت کلاینت داده می‌شود.

به‌صورت اختیاری، امکان مشخص کردن طرحواره URI در WebSocket مانند ws:// یا wss:// برای اتصال‌های رمزنگاری‌نشده و رمزنگاری‌شده وجود دارد. به عنوان مثال: wss://goaccess.io

اگر GoAccess در پشت یک پراکسی اجرا می‌شود، می‌توانید سمت کلاینت را طوری تنظیم کنید که با مشخص کردن میزبان و به دنبال آن دونقطه و درگاه (پورت)، به یک درگاه دیگر متصل شود. به عنوان مثال: goaccess.io:9999

به‌طور پیش‌فرض، تلاش می‌شود تا به نام میزبانِ گزارش تولیدشده متصل شود. اگر GoAccess روی یک سرور راه دور اجرا می‌شود، میزبان سرور راه دور باید در اینجا مشخص شود. همچنین، مطمئن شوید که یک میزبان معتبر است و نه یک نشانی http.

--ping-interval=<secs>

فعال‌سازی پینگ WebSocket با بازه زمانی مشخص بر حسب ثانیه. این گزینه به جلوگیری از قطع شدن اتصالات غیرفعال (idle) کمک می‌کند.

--fifo-in=<path/file>

یک لوله نام‌گذاری‌شده (FIFO) ایجاد می‌کند که از مسیر/فایل داده‌شده می‌خواند.

--fifo-out=<path/file>

یک لوله نام‌گذاری‌شده (FIFO) ایجاد می‌کند که در مسیر/فایل داده‌شده می‌نویسد.

--ssl-cert=<cert.crt>

مسیر گواهی TLS/SSL. برای فعال‌سازی پشتیبانی از TLS/SSL، برنامه GoAccess نیازمند استفاده هم‌زمان از --ssl-cert و --ssl-key است.

تنها در صورتی که با استفاده از --with-openssl پیکربندی شده باشد.

--ssl-key=<priv.key>

مسیر کلید خصوصی TLS/SSL. برای فعال‌سازی پشتیبانی از TLS/SSL، برنامه GoAccess نیازمند استفاده هم‌زمان از --ssl-cert و --ssl-key است.

تنها در صورتی که با استفاده از --with-openssl پیکربندی شده باشد.

گزینه‌های فایل (FILE OPTIONS)

-

فایل لاگ مورد نظر برای تجزیه از ورودی استاندارد (stdin) خوانده می‌شود.

-f --log-file=<logfile>

تعیین مسیر فایل لاگ ورودی. اگر در فایل پیکربندی تنظیم شود، اولویت بالاتری نسبت به -f در خط فرمان خواهد داشت.

-S --log-size=<bytes>

تعیین اندازه لاگ بر حسب بایت. این گزینه زمانی کاربرد دارد که لاگ‌ها را برای پردازش از طریق لوله‌کشی (pipe) ارسال می‌کنید و اندازه لاگ می‌تواند به‌طور صریح تنظیم شود.

-l --debug-file=<debugfile>

ارسال تمام پیام‌های اشکال‌زدایی (debug) به فایل مشخص‌شده.

-p --config-file=<configfile>

تعیین یک فایل پیکربندی سفارشی برای استفاده. در صورت تنظیم، اولویت بالاتری نسبت به فایل پیکربندی سراسری (در صورت وجود) خواهد داشت.

--external-assets

خروجی دادن دارایی‌های HTML به صورت فایل‌های خارجی JS/CSS. این گزینه برای زمانی که در حال راه‌اندازی خط‌مشی امنیت محتوا (CSP) هستید بسیار مناسب است. این کار دو فایل جداگانه به نام‌های goaccess.js و goaccess.css در همان دایرکتوری فایل report.html شما ایجاد می‌کند.

--invalid-requests=<filename>

ثبت لاگ درخواست‌های نامعتبر در فایل مشخص‌شده.

--unknowns-log=<filename>

ثبت لاگ مرورگرها و سیستم‌عامل‌های ناشناخته در فایل مشخص‌شده.

--no-global-config

عدم بارگیری فایل پیکربندی سراسری. این دایرکتوری معمولاً باید /usr/local/etc باشد، مگر اینکه با --sysconfdir=/dir مشخص شده باشد. برای یافتن فایل پیکربندی پیش‌فرض، گزینه --dcf را ببینید..SS گزینه‌های تجزیه (PARSE OPTIONS)

-a --agent-list

فعال‌سازی فهرست user-agentها بر اساس میزبان (host). برای تجزیه سریع‌تر، این پرچم را فعال نکنید.

-d --with-output-resolver

فعال‌سازی تحلیل‌گر IP (IP resolver) در خروجی HTML|JSON.

-e --exclude-ip=<IP|IP-range>

مستثنی کردن یک IPv4 یا IPv6 از شمارش. این گزینه صرفاً در هنگام پردازش داده‌های لاگ دسترسی اعمال می‌شود و داده‌های ذخیره‌شده (persisted) را مستثنی نمی‌کند. همچنین می‌توان بازه‌ها را با استفاده از یک خط تیره میان IPها (start-end) مشخص کرد.

مثال‌ها:
exclude-ip 127.0.0.1
exclude-ip 192.168.0.1-192.168.0.100
exclude-ip ::1
exclude-ip 0:0:0:0:0:ffff:808:804-0:0:0:0:0:ffff:808:808

-j --jobs=<1-6>

این گزینه تعداد رشته‌های پردازش موازی (threads) را برای استفاده در حین اجرای برنامه مشخص می‌کند. این مقدار درجه همزمانی را هنگام تحلیل داده‌های لاگ تعیین کرده و امکان پردازش موازی چندین وظیفه را به صورت هم‌زمان فراهم می‌سازد. مقدار پیش‌فرض آن ۱ رشته است. معمول است که تعداد کارها (jobs) بر اساس منابع سخت‌افزاری موجود، مانند تعداد هسته‌های CPU، تنظیم شود.

-H --http-protocol=<yes|no>

تنظیم/لغو پروتکل درخواست HTTP. این کار کلید درخواستی شامل پروتکل درخواست + خود درخواست واقعی ایجاد می‌کند.

-M --http-method=<yes|no>

تنظیم/لغو متد درخواست HTTP. این کار کلید درخواستی شامل متد درخواست + خود درخواست واقعی ایجاد می‌کند.

-o --output=<path/file.[json|csv|html]>

نوشتن خروجی در stdout با توجه به یکی از فایل‌های زیر و پسوند متناظر برای قالب خروجی:

/path/file.csv - مقادیر جداشده با ویرگول (CSV)
/path/file.json - جی‌سان (JSON - JavaScript Object Notation)
/path/file.html - اچ‌تی‌ام‌ال (HTML)

-q --no-query-string

نادیده گرفتن رشته پرس‌وجو (query string) در درخواست. یعنی: www.google.com/page.htm?query => www.google.com/page.htm.

نکته: حذف رشته پرس‌وجو می‌تواند مصرف حافظه را به ویژه در درخواست‌های دارای مهر زمانی (timestamped) به طور چشمگیری کاهش دهد.

-r --no-term-resolver

غیرفعال‌سازی تحلیل‌گر IP در خروجی ترمینال.

--444-as-404

در نظر گرفتن کد وضعیت غیر استاندارد 444 به عنوان 404.

--4xx-to-unique-count

افزودن خطاهای کلاینت 4xx به شمارش بازدیدکنندگان یکتا.

--anonymize-ip

ناشناس‌سازی نشانی IP کلاینت. گزینه ناشناس‌سازی IP آخرین بایت (octet) نشانی‌های IPv4 کاربران و آخرین ۸۰ بیت نشانی‌های IPv6 را به صفر تغییر می‌دهد. به عنوان مثال، 192.168.20.100 => 192.168.20.0 به عنوان مثال، 2a03:2880:2110:df07:face:b00c::1 => 2a03:2880:2110:df07::

نکته: این گزینه -a را غیرفعال می‌کند.

--chunk-size=<256-32768>

این گزینه تعداد خطوط تشکیل‌دهنده یک تکه (chunk) را تعیین می‌کند. این پارامتر اندازه داده‌های پردازش‌شده به صورت هم‌زمان توسط هر رشته را تحت تأثیر قرار داده و امکان موازی‌سازی وظایف خواندن و پردازش فایل را فراهم می‌سازد. مقدار chunk-size بر کارایی پردازش موازی اثر می‌گذارد و می‌توان آن را بر اساس عواملی مانند منابع سیستم و ویژگی‌های داده‌های ورودی تنظیم کرد.

مقادیر کم: اگر chunk-size خیلی کم تنظیم شود، ممکن است به پردازش ناکارآمد منجر شود. به عنوان مثال، اگر هر تکه شامل تعداد بسیار کمی خط باشد، بار اضافی مدیریت و هماهنگی پردازش موازی ممکن است از مزایای آن بیشتر شود.

مقادیر زیاد: برعکس، اگر chunk-size بیش از حد بزرگ تنظیم شود، می‌تواند به اتمام منابع بیانجامد. هر تکه نمایانگر بخشی از داده است که یک رشته به صورت موازی پردازش می‌کند. تنظیم chunk-size روی مقداری بیش از حد بزرگ ممکن است باعث مشکلات حافظه شود، به ویژه اگر تعداد زیادی رشته موازی به طور هم‌زمان در حال اجرا باشند.

--anonymize-level

سطوح ناشناس‌سازی را مشخص می‌کند: 1 => پیش‌فرض، 2 => قوی، 3 => دقیق (pedantic).

بیت‌های پنهان‌شده	سطح ۱	سطح ۲	سطح ۳
IPv4	8	16	24
IPv6	64	80	96

--all-static-files

شامل کردن فایل‌های ایستایی (static) که حاوی رشته پرس‌وجو (query string) هستند؛ مانند: /fonts/fontawesome-webfont.woff?v=4.0.3

--browsers-file=<path>

به طور پیش‌فرض GoAccess فهرستی گلچین‌شده و «پایه/ضروری» از مرورگرها و خزنده‌ها را تجزیه می‌کند. در صورتی که نیاز به افزودن مرورگرهای بیشتری دارید، از این گزینه استفاده کنید. یک فهرست تفکیک‌شده اضافی از مرورگرها/خزنده‌ها/فیدها و غیره را وارد کنید. برای نمونه به config/browsers.list مراجعه کنید یا پیوند زیر را ببینید: https://raw.githubusercontent.com/allinurl/goaccess/master/config/browsers.list

--date-spec=<date|hr|min>

تنظیم دقت تاریخ بر روی date (پیش‌فرض)، hr برای نمایش ساعت، یا min برای نمایش دقیقه‌های الحاق‌شده به تاریخ.

این گزینه در پنل بازدیدکنندگان (visitors) استفاده می‌شود و برای ردیابی بازدیدکنندگان در سطح ساعت مفید است. برای نمونه، دقت در سطح ساعت موجب نمایش ترافیک به صورت 18/Dec/2010:19 و دقت در سطح دقیقه به صورت 18/Dec/2010:19:59 می‌شود.

--double-decode

رمزگشایی مقادیری که دو بار کدگذاری (double-encoded) شده‌اند. این شامل user-agent، درخواست (request) و ارجاع‌دهنده (referrer) می‌شود.

--enable-panel=<PANEL>

فعال‌سازی تجزیه و نمایش پنل مشخص‌شده.

پنل‌های موجود:
VISITORS
REQUESTS
REQUESTS_STATIC
NOT_FOUND
HOSTS
OS
BROWSERS
VISIT_TIMES
VIRTUAL_HOSTS
REFERRERS
REFERRING_SITES
KEYPHRASES
STATUS_CODES
REMOTE_USER
CACHE_STATUS
GEO_LOCATION
MIME_TYPE
TLS_TYPE

--fname-as-vhost=<regex>

استفاده از نام(های) فایل لاگ به عنوان میزبان(های) مجازی (virtual hosts). یک عبارت منظم (regex) سازگار با POSIX برای استخراج میزبان مجازی از نام فایل ارسال می‌شود. به عنوان مثال، --fname-as-vhost='[a-z]*.[a-z]*' می‌تواند برای استخراج awesome.com.log => awesome.com استفاده شود.

--hide-referrer=<NEEDLE>

مخفی کردن ارجاع‌دهنده در عین محاسبه و شمارش آن. الگوهای عمومی (wildcards) در عبارت مورد جستجو (needle) مجاز هستند؛ مانند *.bing.com.

--hour-spec=<hr|min>

تنظیم دقت زمان بر روی hour (پیش‌فرض) یا min برای نمایش یک‌دهم ساعت الحاق‌شده به ساعت.

این گزینه در پنل توزیع زمانی (time distribution) استفاده می‌شود و برای ردیابی اوج‌های ترافیک سرور شما در زمان‌های خاص کاربرد دارد.

--ignore-crawlers

نادیده گرفتن خزنده‌ها (crawlers) در شمارش.

--unknowns-as-crawlers

دسته‌بندی سیستم‌عامل‌ها و مرورگرهای ناشناخته به عنوان خزنده (crawler).

--ignore-panel=<PANEL>

نادیده گرفتن تجزیه و نمایش پنل مشخص‌شده.

پنل‌های موجود:
VISITORS
REQUESTS
REQUESTS_STATIC
NOT_FOUND
HOSTS
OS
BROWSERS
VISIT_TIMES
VIRTUAL_HOSTS
REFERRERS
REFERRING_SITES
KEYPHRASES
STATUS_CODES
REMOTE_USER
CACHE_STATUS
GEO_LOCATION
MIME_TYPE
TLS_TYPE

--ignore-referrer=<referrer>

صرف‌نظر کردن از ارجاع‌دهنده‌ها (referrers) در شمارش. استفاده از کاراکترهای عمومی (wildcards) مجاز است؛ مانند: *.domain.com ww?.domain.*.TP --ignore-statics=<req|panel> نادیده گرفتن درخواست‌های فایل‌های ایستا (static).

req
تنها نادیده گرفتن درخواست‌ها از درخواست‌های معتبر

panels
نادیده گرفتن درخواست‌ها از تابلوها (پنل‌ها).

توجه داشته باشید که این گزینه آن‌ها را در تعداد کل درخواست‌ها به شمار می‌آورد

--ignore-status=<CODE>

نادیده گرفتن تجزیه و نمایش یک یا چند کد وضعیت (status code). برای چند کد وضعیت، از این گزینه چندین بار استفاده کنید.

--keep-last=<num_days>

نگهداری تعداد روزهای مشخص‌شده اخیر در فضای ذخیره‌سازی. این کار جدول‌های ذخیره‌سازی را بازیافت (recycle) می‌کند؛ برای مثال، نگهداری و نمایش تنها ۷ روز گذشته.

--no-ip-validation

غیرفعال کردن اعتبارسنجی IP کلاینت. برای مواردی مفید است که آدرس‌های IP پیش از ثبت در لاگ مبهم‌سازی (obfuscated) شده باشند. لاگ همچنان باید حاوی یک جای‌نگه‌دار برای %h باشد، که معمولاً یک IP تحلیل‌شده است؛ مانند ord37s19-in-f14.1e100.net.

--no-strict-status

غیرفعال کردن اعتبارسنجی کد وضعیت HTTP. برخی سرورها این مقدار را تنها در صورتی ثبت می‌کنند که اتصالی با مقصد برقرار شده باشد و مقصد پاسخی فرستاده باشد. در غیر این صورت، ممکن است به‌صورت - ثبت شود.

--num-tests=<number>

تعداد خطوطی از لاگ دسترسی (access log) که باید در برابر قالب لاگ/تاریخ/زمان ارائه‌شده آزموده شوند. به‌طور پیش‌فرض، تجزیه‌کننده برای آزمودن ۱۰ خط تنظیم شده است. اگر روی 0 تنظیم شود، تجزیه‌کننده هیچ خطی را نمی‌آزماید و تمام لاگ دسترسی را تجزیه خواهد کرد. اگر خطی پیش از رسیدن به <number> با قالب لاگ/تاریخ/زمان داده‌شده مطابقت داشته باشد، تجزیه‌کننده لاگ را معتبر در نظر می‌گیرد، در غیر این صورت GoAccess مقدار EXIT_FAILURE را برمی‌گرداند و پیام‌های خطای مربوطه را نمایش می‌دهد.

--process-and-exit

تجزیه لاگ و خروج بدون خروجی دادن داده‌ها. برای زمانی مفید است که تنها به‌دنبال افزودن داده‌های جدید به پایگاه داده روی دیسک بدون ایجاد خروجی در یک فایل یا یک ترمینال هستیم.

--real-os

نمایش نام‌های واقعی سیستم‌عامل؛ مانند Windows XP، Snow Leopard.

--sort-panel=<PANEL,FIELD,ORDER>

مرتب‌سازی تابلو (پنل) در بارگذاری اولیه. گزینه‌های مرتب‌سازی با کاما از هم جدا می‌شوند. گزینه‌ها به این صورت هستند: PANEL,METRIC,ORDER

معیارهای در دسترس:
BY_HITS - مرتب‌سازی بر اساس تعداد بازدیدها (hits)
BY_VISITORS - مرتب‌سازی بر اساس بازدیدکنندگان یکتا
BY_DATA - مرتب‌سازی بر اساس حجم داده
BY_BW - مرتب‌سازی بر اساس پهنای باند
BY_AVGTS - مرتب‌سازی بر اساس میانگین زمان پاسخ‌دهی
BY_CUMTS - مرتب‌سازی بر اساس مجموع زمان پاسخ‌دهی
BY_MAXTS - مرتب‌سازی بر اساس بیشینه زمان پاسخ‌دهی
BY_PROT - مرتب‌سازی بر اساس پروتکل http
BY_MTHD - مرتب‌سازی بر اساس متد http

ترتیب‌های در دسترس:
ASC
DESC

--static-file=<extension>

افزودن پسوند فایل ایستا؛ برای مثال: .mp3 پسوندها به حروف کوچک و بزرگ حساس هستند.

گزینه‌های موقعیت مکانی (GEOLOCATION OPTIONS)

-g --std-geoip

استفاده از پایگاه داده استاندارد GeoIP برای مصرف حافظه کمتر.

--geoip-database=<geofile>

مشخص کردن مسیر فایل پایگاه داده GeoIP؛ برای مثال GeoLiteCity.dat.

در صورت استفاده از GeoIP2، باید پایگاه داده GeoLite2 City یا Country را از MaxMind.com دریافت کرده و از گزینه --geoip-database برای مشخص کردن پایگاه داده استفاده کنید. همچنین می‌توانید فایل‌های پایگاه داده به‌روزشده را برای GeoIP legacy از طریق GeoLite Legacy Databases در MaxMind.com بیابید. فایل‌های IPv4 و IPv6 نیز پشتیبانی می‌شوند. برای نشانی‌های به‌روزشده پایگاه داده، لطفاً فایل پیکربندی پیش‌فرض GoAccess را ببینید.

نکته: --geoip-city-data نام مستعاری برای --geoip-database است.

سایر گزینه‌ها (OTHER OPTIONS)

-h --help

راهنما.

-s --storage

نمایش روش ذخیره‌سازی فعلی؛ مانند B+ Tree یا Hash.

-V --version

نمایش اطلاعات نسخه و خروج.

--dcf

نمایش مسیر فایل پیکربندی پیش‌فرض هنگامی که از `-p` استفاده نشده است.

گزینه‌های ذخیره‌سازی پایدار (PERSISTENCE STORAGE OPTIONS)

--persist

پایدارسازی داده‌های تجزیه‌شده بر روی دیسک. در صورت وجود فایل‌های پایگاه داده، بازنویسی خواهند شد. این گزینه باید برای نخستین مجموعه داده تنظیم شود. مثال‌های زیر را ببینید.

--restore

بارگذاری داده‌های پیش‌تر ذخیره‌شده از روی دیسک. در صورت خواندن داده‌های پایدارسازی‌شده به‌تنهایی، فایل‌های پایگاه داده باید وجود داشته باشند. --persist و مثال‌های زیر را ببینید.

--db-path=<dir>

مسیری که فایل‌های پایگاه داده روی دیسک در آن ذخیره می‌شوند. مقدار پیش‌فرض، دایرکتوری /tmp است..SH "قالب سفارشی لاگ/تاریخ (CUSTOM LOG/DATE FORMAT)" ابزار GoAccess می‌تواند تقریباً هر قالب لاگ وبی را تجزیه و تحلیل کند.

گزینه‌های از پیش تعریف‌شده شامل Common Log Format (CLF)، Combined Log Format (XLF/ELF)، از جمله virtual host، Amazon CloudFront (Download Distribution)، Google Cloud Storage و قالب W3C (IIS) هستند.

همچنین GoAccess اجازه استفاده از هر رشته قالب سفارشی دیگری را نیز می‌دهد.

دو روش برای پیکربندی قالب لاگ وجود دارد. ساده‌ترین راه، اجرای GoAccess با -c برای نمایش یک پنجره پیکربندی است. در غیر این صورت، می‌توان آن را در ~/.goaccessrc یا %sysconfdir% پیکربندی کرد.

time-format

متغیر time-format که پس از آن یک فاصله قرار می‌گیرد، زمان قالب لاگ را مشخص می‌کند که شامل هر ترکیبی از نویسه‌های معمولی و مشخص‌کننده‌های قالب ویژه است. همه آن‌ها با علامت درصد (%) شروع می‌شوند. به `man strftime` مراجعه کنید. %T یا %H:%M:%S.

نکته: اگر یک برچسب زمانی بر حسب میکروثانیه داده شده باشد، باید از %f به عنوان time-format یا از %* در صورتی که برچسب زمانی بر حسب میلی‌ثانیه باشد، استفاده شود.

date-format

متغیر date-format که پس از آن یک فاصله قرار می‌گیرد، تاریخ قالب لاگ را مشخص می‌کند که شامل هر ترکیبی از نویسه‌های معمولی و مشخص‌کننده‌های قالب ویژه است. همه آن‌ها با علامت درصد (%) شروع می‌شوند. به `man strftime` مراجعه کنید. به عنوان مثال: %Y-%m-%d.

نکته: اگر یک برچسب زمانی بر حسب میکروثانیه داده شده باشد، باید از %f به عنوان date-format یا از %* در صورتی که برچسب زمانی بر حسب میلی‌ثانیه باشد، استفاده شود.

log-format

متغیر log-format که پس از آن یک فاصله یا \t می‌آید، رشته قالب لاگ را مشخص می‌کند.

%x

یک فیلد تاریخ و زمان منطبق با متغیرهای time-format و date-format است. این فیلد زمانی استفاده می‌شود که یک برچسب زمانی داده شده باشد یا تاریخ و زمان به صورت یک رشته واحد به یکدیگر متصل شده باشند (مانند 1501647332 یا 20170801235000) به جای اینکه تاریخ و زمان در دو متغیر جداگانه قرار گیرند.

%t

فیلد زمان منطبق با متغیر time-format است.

%d

فیلد تاریخ منطبق با متغیر date-format است.

%v

نام رسمی کارساز (Canonical Server Name) که به درخواست پاسخ می‌دهد (Virtual Host).

%e

این فیلد شناسه کاربری (userid) شخصی است که سند را طبق احراز هویت HTTP درخواست کرده است.

%C

وضعیت حافظه پنهان (Cache) شیئی که توسط کارساز ارائه شده است.

%h

میزبان (نشانی IP کلاینت، خواه IPv4 یا IPv6).

%r

خط درخواست از کلاینت. برای اینکه این مقدار قابل تجزیه باشد، نیاز به جداکننده‌های خاصی در اطراف درخواست (مانند نقل‌قول تکی، نقل‌قول دوگانه یا هر چیز دیگری) دارد. در غیر این صورت، باید از ترکیبی از مشخص‌کننده‌های قالب ویژه مانند %m %U %H استفاده کنیم.

%q

رشته پرس‌وجو (query string).

%m

روش درخواست (request method).

%U

مسیر URL درخواست‌شده.

نکته: اگر رشته پرس‌وجو در %U باشد، نیازی به استفاده از %q نیست. با این حال، اگر مسیر URL شامل هیچ رشته پرس‌وجویی نباشد، می‌توانید از %q استفاده کنید و رشته پرس‌وجو به انتهای درخواست ضمیمه خواهد شد.

%H

پروتکل درخواست.

%s

کد وضعیتی که کارساز به کلاینت بازمی‌گرداند.

%b

اندازه شیء بازگردانده‌شده به کلاینت.

%R

سرآیند درخواست HTTP ارجاع‌دهنده ("Referrer").

%u

سرآیند درخواست HTTP عامل کاربر ("user-agent").

%K

تنظیمات رمزنگاری TLS انتخاب‌شده برای اتصال. (در LogFormat آپاچی: %{SSL_PROTOCOL}x)

%k

تنظیمات رمزنگاری TLS انتخاب‌شده برای اتصال. (در LogFormat آپاچی: %{SSL_CIPHER}x)

%M

نوع MIME منبع درخواست‌شده. (در LogFormat آپاچی: %{Content-Type}o)

%D

زمان صرف‌شده برای پاسخ به درخواست، بر حسب میکروثانیه به صورت یک عدد اعشاری (در مبنای ده).

%T

زمان صرف‌شده برای پاسخ به درخواست، بر حسب ثانیه با تفکیک‌پذیری میلی‌ثانیه‌ای.

%L

زمان صرف‌شده برای پاسخ به درخواست، بر حسب میلی‌ثانیه به صورت یک عدد اعشاری (در مبنای ده).

%n

زمان صرف‌شده برای پاسخ به درخواست، بر حسب نانوثانیه.

%^

نادیده گرفتن این فیلد.

%~

حرکت به جلو در طول رشته لاگ تا زمانی که یک نویسه غیرفاصله (!isspace) یافت شود.

~h

میزبان (نشانی IP کلاینت، خواه IPv4 یا IPv6) در فیلد X-Forwarded-For (XFF).

این بخش از یک مشخص‌کننده ویژه استفاده می‌کند که شامل یک علامت مدک (~) پیش از مشخص‌کننده میزبان است و به دنبال آن نویسه(هایی) که فیلد XFF را جدا می‌کنند و درون دو ابرو محصور شده‌اند، می‌آید؛ مانند "~h{, }

برای مثال، "~h{, }" برای تجزیه فیلد "11.25.11.53, 17.68.33.17" که با یک ویرگول و یک فاصله جدا شده است (درون علامت‌های نقل‌قول دوگانه محصور شده)، استفاده می‌شود.

فیلد XFF	مشخص‌کننده
"192.1.2.3,  192.68.33.17, 192.1.1.2"	"~h{, }"
"192.1.2.12", "192.68.33.17"	~h{", }
192.1.2.12, 192.68.33.17	~h{, }
192.1.2.14 192.68.33.17 192.1.1.2	~h{ }

نکته: به منظور دریافت میانگین، زمان تجمعی و بیشینه زمان پاسخ‌دهی در GoAccess، باید ثبت زمان پاسخ را در کارساز وب خود فعال کنید. در Nginx می‌توانید $request_time را به قالب لاگ خود اضافه کنید، یا %D را در Apache.

مهم: اگر چندین مشخص‌کننده زمان پاسخ به طور هم‌زمان استفاده شوند، نخستین گزینه مشخص‌شده در رشته قالب نسبت به سایر مشخص‌کننده‌ها اولویت خواهد داشت.

ابزار GoAccess نیازمند فیلدهای زیر است:

%h یک IPv4/6 معتبر

%d یک تاریخ معتبر

%r درخواست.SH "منوی تعاملی (INTERACTIVE MENU)"

F1 یا h

راهنمای اصلی.

F5

بازترسیم پنجره اصلی.

q

خروج از برنامه، پنجره فعلی یا جمع کردن ماژول فعال.

o یا ENTER

باز کردن ماژول انتخاب‌شده یا باز کردن پنجره.

+

باز کردن زیرمجموعه‌های آیتم انتخاب‌شده در صورتی که ماژول از قبل باز شده باشد.

-

جمع کردن زیرمجموعه‌های آیتم انتخاب‌شده در صورتی که ماژول از قبل باز شده باشد.

0-9 و Shift + 0

تنظیم ماژول انتخاب‌شده به عنوان ماژول فعال.

p

بازآرایی تعاملی پنل‌های پیشخوان (فشردن `p` یا `P`).

j

پیمایش به پایین در ماژول بازشده.

k

پیمایش به بالا در ماژول بازشده.

c

تنظیم یا تغییر طرح رنگ (scheme color).

r

تغییر وضعیت ترتیب معکوس میله‌های نمودار برای ماژول فعال.

m

چرخش رو به جلو در معیارهای نمودار برای ماژول فعال (hits، بازدیدکنندگان، پهنای باند).

M

چرخش رو به عقب در معیارهای نمودار برای ماژول فعال.

l

تغییر وضعیت مقیاس لگاریتمی میله‌های نمودار در ماژول فعال.

TAB

حرکت رو به جلو میان ماژول‌ها. از ماژول فعال فعلی شروع می‌شود.

SHIFT + TAB

حرکت رو به عقب میان ماژول‌ها. از ماژول فعال فعلی شروع می‌شود.

^f

پیمایش یک صفحه به جلو درون یک ماژول فعال.

^b

پیمایش یک صفحه به عقب درون یک ماژول فعال.

s

گزینه‌های مرتب‌سازی برای ماژول فعال.

/

جست‌وجو در تمام ماژول‌ها (عبارات باقاعده مجاز است).

n

یافتن موقعیت رخداد بعدی در تمام ماژول‌ها.

g

رفتن به اولین آیتم یا بالای صفحه.

G

رفتن به آخرین آیتم یا پایین صفحه.

خروجی‌های گوناگون (DIFFERENT OUTPUTS)

برای ارسال خروجی به ترمینال و تولید یک گزارش تعاملی:

# goaccess access.log

برای تولید یک گزارش HTML:

# goaccess access.log -a -o report.html

برای تولید یک گزارش JSON:

# goaccess access.log -a -d -o report.json

برای تولید یک فایل CSV:

# goaccess access.log --no-csv-summary -o report.csv

همچنین GoAccess امکان پایش بی‌درنگ (real-time) از طریق stdin را فراهم می‌کند:

# tail -f access.log | goaccess -

برای پالایش (فیلتر کردن) هم‌زمان با باز نگه‌داشتن لوله جهت تحلیل بی‌درنگ:

# tail -f access.log | grep -i --line-buffered 'firefox' | goaccess --log-format=COMBINED -

تجزیه از ابتدای فایل در حین باز نگه‌داشتن لوله:

# tail -f -n +0 access.log | grep -i --line-buffered 'firefox' | goaccess --log-format=COMBINED -o report.html --real-time-html -

تبدیل منطقه زمانی تاریخ لاگ به Europe/Berlin:

# goaccess access.log --log-format='%h %^[%x] "%r" %s %b "%R" "%u"' --datetime-format='%d/%b/%Y:%H:%M:%S %z' --tz=Europe/Berlin --date-spec=min

چندین فایل لاگ (MULTIPLE LOG FILES)

تجزیه چندین فایل لاگ با ارسال آن‌ها به خط فرمان:

# goaccess access.log access.log.1

تجزیه از یک لوله هم‌زمان با خواندن فایل‌های معمولی (افزودن - برای stdin):

# cat access.log.2 | goaccess access.log access.log.1 -

توجه: علامت خط تیره تکی به خط فرمان اضافه می‌شود تا GoAccess بداند که باید ورودی را از طریق لوله (pipe) بخواند.

پردازش تمام فایل‌های لاگ فشرده‌شده به همراه لاگ فعلی:

# zcat access.log.*.gz | goaccess access.log -

نکته: در macOS، به‌جای zcat از gunzip -c استفاده کنید. نکته: اگر GoAccess با گزینه --with-zlib کامپایل شده باشد، می‌تواند فایل‌های .gz را مستقیماً و بدون نیاز به ابزارهای فشرده‌زدای خارجی تجزیه کند:

# goaccess access.log access.log.1.gz access.log.2.gz

خروجی HTML بی‌درنگ (REAL-TIME HTML OUTPUT)

تولید یک گزارش HTML بی‌درنگ:

# goaccess access.log -o /usr/share/nginx/html/site/report.html --real-time-html

مشخص کردن صریح نشانی اینترنتی WebSocket:

# goaccess access.log -o report.html --real-time-html --ws-url=goaccess.io

استفاده از یک درگاه (پورت) سفارشی:

# goaccess access.log -o report.html --real-time-html --port=9870

مقید کردن WebSocket به یک آدرس مشخص:

# goaccess access.log -o report.html --real-time-html --addr=127.0.0.1

نکته: برای خروجی بی‌درنگ مبتنی بر TLS/SSL، از --ssl-cert=<cert.crt> و --ssl-key=<priv.key> استفاده کنید. اگر GoAccess پشت یک پراکسی معکوس (reverse proxy) اجرا می‌شود، نشانی اینترنتی WebSocket را طوری تنظیم کنید که شامل مسیر و پورت پراکسی باشد، به عنوان مثال:

# goaccess access.log -o report.html --real-time-html --ws-url=goaccess.io:8080/ws.SS کار با تاریخ‌ها (WORKING WITH DATES)

همه درخواست‌ها از یک تاریخ مشخص تا انتهای فایل:

# sed -n '/05Dec2010/,$ p' access.log | goaccess -a -

استفاده از یک تاریخ نسبی (یک هفته پیش):

# sed -n '/'$(date '+%d%b%Y' -d '1 week ago')'/,$ p' access.log | goaccess -a -

تجزیه یک بازه تاریخی مشخص:

# sed -n '/5Nov2010/,/5Dec2010/ p' access.log | goaccess -a -

تنها نگه‌داشتن داده‌های ۵ روز اخیر:

# goaccess access.log --keep-last=5

میزبان‌های مجازی (VIRTUAL HOSTS)

از --concat-vhost-req برای افزودن میزبان مجازی یا بلوک سرور (%v) به ابتدای فیلد درخواست استفاده کنید.

الحاق دستی میزبان مجازی:

# awk '$8=$1$8' access.log | goaccess -a -

مستثنی کردن فهرستی از میزبان‌های مجازی:

# grep -v "`cat exclude_vhost_list_file`" vhost_access.log | goaccess -

فایل‌ها، کدهای وضعیت و ربات‌ها (FILES, STATUS CODES & BOTS)

تنها تجزیه انواع خاصی از صفحات (html، htm، php):

# awk '$7~/.html|.htm|.php/' access.log | goaccess -

تجزیه بازدیدهای صفحه بدون پسوند:

# awk '$7!~/..*$/' access.log | goaccess -

فیلتر کردن بر اساس یک کد وضعیت منفرد (مثلاً 500):

# awk '$9~/500/' access.log | goaccess -

فیلتر کردن بر اساس چندین کد وضعیت (3xx یا 5xx):

# tail -f -n +0 access.log | awk '$9~/3[0-9]{2}|5[0-9]{2}/' | goaccess -o out.html -

تخمین ترافیک ربات‌ها:

# tail -F -n +0 access.log | grep -i --line-buffered 'bot' | goaccess -

سرور (SERVER)

اجرای GoAccess با اولویت پردازشی (CPU) پایین‌تر:

# nice -n 19 goaccess -f access.log -a

انتقال لاگ‌ها از یک سرور دوردست از طریق لوله (Pipe):

# ssh -n root@server 'tail -f /var/log/apache2/access.log' | goaccess -

نکته: دستور SSH نیازمند -n است تا GoAccess بتواند از ورودی استاندارد (stdin) بخواند. برای احراز هویت از کلیدهای SSH استفاده کنید.

پردازش افزایشی لاگ (INCREMENTAL LOG PROCESSING)

ابزار GoAccess می‌تواند لاگ‌ها را با ذخیره دائمی داده‌ها روی دیسک، سپس بازیابی آن‌ها و الحاق داده‌های جدید، به صورت افزایشی پردازش کند. GoAccess شماره‌های inode، آخرین خط تجزیه‌شده و آخرین برچسب زمانی را به ازای هر فایل رهگیری می‌کند.

نکته: اگر inode مطابقت نداشته باشد، تمام خطوط تجزیه می‌شوند. اگر مطابقت داشته باشد، خطوط باقی‌مانده خوانده شده و تعداد خطوط/برچسب زمانی به‌روزرسانی می‌شوند. خطوط لاگ با برچسب زمانی ≤ مقدار ذخیره‌شده نادیده گرفته می‌شوند. داده‌های لوله‌کشی‌شده (piped) بر اساس برچسب زمانی آخرین خط خوانده‌شده عمل می‌کنند.

هشدار: داده‌های لوله‌کشی‌شده (piped) ممکن است ورودی‌های تکراری ایجاد کنند زیرا چندین خط متوالی می‌توانند برچسب زمانی یکسانی داشته باشند. بهترین روش برای پردازش افزایشی این است که داده‌ها به جای پایپ کردن، مستقیماً با GoAccess تجزیه شوند.

ذخیره دائمی لاگ ماه گذشته:

# goaccess access.log.1 --persist

الحاق لاگ این ماه و حفظ آن:

# goaccess access.log --restore --persist

تنها خواندن داده‌های ذخیره‌شده:

# goaccess --restore

نکات (NOTES)

ابزار GoAccess شماره‌های inode تمام فایل‌های پردازش‌شده را رهگیری می‌کند (با این فرض که فایل‌ها روی همان پارتیشن باقی بمانند)؛ علاوه بر این، قطعه‌ای از داده‌های لاگ را به همراه آخرین خط تجزیه‌شده از هر فایل و برچسب زمانی آخرین خط تجزیه‌شده استخراج می‌کند. به عنوان مثال: inode:29627417|line:20012|ts:20171231235059

ابتدا بررسی می‌کند که آیا این قطعه داده با لاگی که در حال تجزیه است مطابقت دارد یا خیر؛ اگر مطابقت داشت، فرض می‌کند که لاگ تغییر فاحشی نکرده است، مثلاً کوتاه (truncate) نشده است. اگر inode با فایل فعلی مطابقت نداشته باشد، تمام خطوط را تجزیه می‌کند. اگر فایل فعلی با inode مطابقت داشته باشد، سپس خطوط باقی‌مانده را می‌خواند و تعداد خطوط تجزیه‌شده و برچسب زمانی را به‌روزرسانی می‌کند. به عنوان یک اقدام احتیاطی مضاعف، خطوط لاگی را که برچسب زمانی آن‌ها ≤ برچسب ذخیره‌شده است تجزیه نخواهد کرد.

داده‌های لوله‌کشی‌شده (piped) بر اساس برچسب زمانی آخرین خط خوانده‌شده عمل می‌کنند. به عنوان مثال، تمام ورودی‌های دریافتی را تا زمانی که به یک برچسب زمانی >= مقدار ذخیره‌شده برسد، تجزیه کرده و دور می‌اندازد.

به عنوان مثال:

// لاگ دسترسی ماه گذشته
# goaccess access.log.1 --persist

سپس، بارگذاری آن با:

// الحاق لاگ دسترسی این ماه، و حفظ داده‌های جدید
# goaccess access.log --restore --persist

تنها برای خواندن داده‌های ذخیره‌شده (بدون تجزیه داده‌های جدید):

# goaccess --restore هر پنل فعال در مجموع دارای ۳۶۶ آیتم، یا ۵۰ آیتم در گزارش زنده HTML است. تعداد آیتم‌ها با استفاده از max-items قابل سفارشی‌سازی است. توجه داشته باشید که خروجی‌های HTML، CSV و JSON مقداری بیش از مقدار پیش‌فرض ۳۶۶ آیتم در هر پنل را مجاز می‌دانند.

یک hit یک درخواست است (یک سطر در گزارش دسترسی)، برای مثال، ۱۰ درخواست = ۱۰ hit. درخواست‌های HTTP با IP، تاریخ و user agent یکسان، یک بازدید یکتا (unique visit) در نظر گرفته می‌شوند.

اگر می‌خواهید پشتیبانی از dual-stack را فعال کنید، لطفاً از --addr=:: به جای مقدار پیش‌فرض --addr=0.0.0.0 استفاده کنید.

گزارش تولیدشده پس از ۱ ثانیه با عقب‌نشینی نمایی (exponential backoff) تلاش خواهد کرد مجدداً به سرور WebSocket متصل شود. این گزارش ۲۰ بار برای برقراری اتصال تلاش خواهد کرد.