확장 기능:ApiFeatureUsage
From mediawiki.org
This page is a translated version of the page Extension:ApiFeatureUsage and the translation is 4% complete.
Languages:
출시 상태: 안정 |
|
|---|---|
| 구현 | 특수 문서 , API |
| 설명 | Access API feature usage log summaries |
| 만든 이 | Brad Jorsch (Anomie 토론 ) |
| 최신 버전 | 1.0 (2016年12月07日) |
| 호환성 정책 | 스냅샷은 미디어위키와 함께 릴리스됩니다. Master is not backward compatible. |
| MediaWiki | 1.25+ |
| PHP | 5.5.9+ |
| 데이터베이스 변경 | 아니오 |
| 가상 도메인 | virtual-apifeatureusage |
|
|
| Licence | GNU General Public License 2.0 or later |
| 다운로드 | |
| ApiFeatureUsage 확장 기능 번역 | |
| 이슈 | 미해결 작업 · 버그 보고 |
The ApiFeatureUsage extension adds a special page and an API module to fetch summaries of data logged by ApiBase::logFeatureUsage(), which is typically an indication of use of deprecated API features.
Dependencies
Log data must be added to some sort of storage system. Currently Elasticsearch is supported via Extension:Elastica .
Installation
- 파일을 다운로드하고
ApiFeatureUsage폴더를extensions/디렉토리에 넣어 주세요.
개발자와 코딩 기여자는 Git을 이용해 확장기능을 다운받는 것이 좋습니다.cdextensions/ gitclonehttps://gerrit.wikimedia.org/r/mediawiki/extensions/ApiFeatureUsage - 아래의 코드를 LocalSettings.php 코드의 마지막에 추가합니다.
wfLoadExtension( 'ApiFeatureUsage' );
- Yes 완료 – 위키의 ‘
Special:Version’에 이동해서, 확장기능이 올바르게 설치된 것을 확인합니다.
Configuration
- Parameters
| Name | Description |
|---|---|
$wgApiFeatureUsageQueryEngineConf
|
Configuration array for accessing the log storage backend.
|
| Name | Required? | Description | Default |
|---|---|---|---|
serverList |
Required | Array of Elasticsearch servers. | |
maxConnectionAttempts |
Optional | Maximum connection attempts. | 1 |
indexPrefix |
Optional | Prefix for the indexes to use. | apifeatureusage-
|
indexFormat |
Optional | Date formatting for the indexes to use, see the PHP manual. | Y.m.d
|
type |
Optional | Elasticsearch type to query. | api-feature-usage-sanitized
|
featureField |
Optional | Field name for the logged value of $feature. | feature
|
timestampField |
Optional | Field name for the logged timestamp. | @timestamp
|
agentField |
Optional | Field name for the logged user agent. | agent
|
Usage
The extension adds a new special page, Special:ApiFeatureUsage, with a simple form to request a summary of feature usage logs for a user agent and date range.
The extension also adds an API query submodule, meta=featureusage.
See the auto-generated API documentation for details.
See also
이 확장 기능은 하나 이상의 위키미디어 프로젝트에서 사용 중입니다. 이것은 아마도 이 확장 기능이 안정적이고 트래픽이 많은 웹 사이트에서 사용할 수 있을 만큼 충분히 잘 작동한다는 것을 의미합니다. 설치된 위치를 확인하려면 위키미디어의 CommonSettings.php 및 InitialiseSettings.php 구성 파일에서 이 확장 기능의 이름을 찾습니다. 특정 위키에 설치된 확장 기능의 전체 목록은 위키의 Special:Version 문서에서 볼 수 있습니다.